{ "swagger": "2.0", "info": { "title": "The Selling Partner API for Action Plans", "description": "The Action Plans API allows you to create, configure, and execute action plans from pre-defined templates or custom-built workflows.", "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" }, "version": "2026-06-01" }, "host": "sellingpartnerapi-na.amazon.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/actionPlans/2026-06-01/plans/{actionPlanId}": { "get": { "operationId": "getActionPlan", "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "summary": "Get an action plan.", "description": "Returns an action plan by ID. Use `includedData=steps` to include the plan's steps with their resolved input and output values.", "tags": [ "actionPlans" ], "parameters": [ { "name": "actionPlanId", "in": "path", "required": true, "type": "string", "description": "The unique identifier of the action plan (UUID).", "x-example": "e5f6a7b8-89ab-cdef-0123-456789abcdef" }, { "name": "locale", "in": "query", "required": false, "type": "string", "description": "The locale for localized content, as an ISO 639 language code and ISO 3166 country code separated by a hyphen. Defaults to `en-US`.", "x-example": "en-US" }, { "name": "includedData", "in": "query", "required": false, "type": "array", "items": { "type": "string", "enum": [ "steps" ] }, "collectionFormat": "csv", "description": "Additional data to include in the response. Include `steps` to include the plan's steps with their resolved input and output values.", "x-example": "steps", "x-docgen-enum-table-extension": [ { "value": "steps", "description": "Include the plan's steps with their resolved input and output values." } ] } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/GetActionPlanResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." } }, "examples": { "application/json": { "plan": { "actionPlanId": "e5f6a7b8-89ab-cdef-0123-456789abcdef", "type": { "definition": { "displayName": { "text": "Cross-store expansion (FBA)", "locale": "en-US" }, "inputs": { "sourceMarketplaceId": { "displayName": { "text": "Source marketplace ID", "locale": "en-US" } }, "targetMarketplaceId": { "displayName": { "text": "Target marketplace ID", "locale": "en-US" } } }, "planDefinitionId": "CROSS_STORE_EXPANSION_FBA" } }, "references": { "actionItems": [ { "actionItemId": "ebf5caf1-8cfb-43bd-a13b-ef91bdb0d930", "resolution": { "definition": { "resolutionDefinitionId": "CROSS_STORE_EXPANSION_FBA" } } } ] }, "displayName": { "text": "Expand FBA to DE — Order #12345", "locale": "en-US" }, "status": [ "DONE" ], "inputs": { "sourceMarketplaceId": { "value": [ "A1PA6795UKMFR9" ] }, "targetMarketplaceId": { "value": [ "A13V1IB3VIYZZH" ] } }, "createdDate": "2025-07-07T14:55:00Z", "lastUpdatedDate": "2025-07-07T17:00:00Z", "acceptedDate": "2025-07-07T15:00:00Z", "startedDate": "2025-07-07T15:01:00Z", "completedDate": "2025-07-07T17:00:00Z", "steps": [ { "stepId": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "mode": "AUTOMATED", "definition": { "displayName": { "text": "Configure Pricing Settings", "locale": "en-US" }, "inputs": { "sourceMarketplaceId": { "displayName": { "text": "Source marketplace ID", "locale": "en-US" } }, "targetMarketplaceId": { "displayName": { "text": "Target marketplace ID", "locale": "en-US" } } }, "outputs": { "pricingRuleId": { "displayName": { "text": "Pricing rule ID", "locale": "en-US" } } }, "stepDefinitionId": "CONFIGURE_PRICING_SETTINGS" }, "description": { "text": "Set up cross-store pricing rules linking pricing in the source and target marketplaces.", "locale": "en-US" }, "dependencies": [], "status": [ "COMPLETED", "SUCCEEDED" ], "startedDate": "2025-07-07T15:01:00Z", "lastUpdatedDate": "2025-07-07T15:15:00Z", "completedDate": "2025-07-07T15:15:00Z", "inputs": { "sourceMarketplaceId": { "value": [ "A1PA6795UKMFR9" ] }, "targetMarketplaceId": { "value": [ "A13V1IB3VIYZZH" ] } }, "outputs": { "pricingRuleId": { "value": [ "PR-FR-XSTORE-001" ] } } }, { "stepId": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "mode": "AUTOMATED", "definition": { "displayName": { "text": "Copy Offers", "locale": "en-US" }, "inputs": { "targetMarketplaceId": { "displayName": { "text": "Target marketplace ID", "locale": "en-US" } }, "fulfillmentChannel": { "displayName": { "text": "Fulfillment channel", "locale": "en-US" } }, "pricingRuleId": { "displayName": { "text": "Pricing rule ID", "locale": "en-US" } } }, "outputs": { "listings": { "displayName": { "text": "Listings", "locale": "en-US" } } }, "stepDefinitionId": "COPY_OFFERS" }, "description": { "text": "Publish offers in the target marketplace using Fulfillment by Amazon.", "locale": "en-US" }, "dependencies": [ "f47ac10b-58cc-4372-a567-0e02b2c3d479" ], "status": [ "COMPLETED", "SUCCEEDED" ], "startedDate": "2025-07-07T16:30:00Z", "lastUpdatedDate": "2025-07-07T17:00:00Z", "completedDate": "2025-07-07T17:00:00Z", "inputs": { "targetMarketplaceId": { "value": [ "A13V1IB3VIYZZH" ] }, "fulfillmentChannel": { "value": [ "FBA" ] }, "pricingRuleId": { "value": [ "PR-FR-XSTORE-001" ] } }, "outputs": { "listings": { "value": [ "LST-FR-001", "LST-FR-002" ] } } } ], "actionItems": [ { "type": { "classifications": [ "ISSUE" ], "definition": { "typeDefinitionId": "MISSING_INPUT", "displayName": { "text": "Missing Input", "locale": "en-US" } } }, "description": { "text": "Step 'Copy Offers' is missing value for sourceMarketplaceId input.", "locale": "en-US" }, "references": { "steps": [ { "stepId": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "attributeNames": [ "sourceMarketplaceId" ] } ] } }, { "type": { "classifications": [ "ISSUE" ], "definition": { "typeDefinitionId": "QUOTA_EXCEEDED", "displayName": { "text": "Quota Exceeded", "locale": "en-US" } } }, "description": { "text": "Maximum concurrent plans reached.", "locale": "en-US" } } ] } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "actionPlanId": { "value": "e5f6a7b8-89ab-cdef-0123-456789abcdef" } } }, "response": { "plan": { "actionPlanId": "e5f6a7b8-89ab-cdef-0123-456789abcdef", "status": [ "DONE" ], "displayName": { "text": "Expand FBA to DE — Order #12345", "locale": "en-US" } } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "actionPlanId": { "value": "INVALID" } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid actionPlanId format. Must be a valid UUID." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "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/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } }, "/actionPlans/2026-06-01/plans": { "post": { "operationId": "createActionPlan", "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "summary": "Create an action plan.", "description": "Creates an action plan from a template. Use `mode=PREVIEW` to return the plan without creating or executing it. Omit `mode` to create the plan and submit it for execution.", "tags": [ "actionPlans" ], "parameters": [ { "name": "body", "in": "body", "required": true, "description": "The request for action plan creation.", "schema": { "$ref": "#/definitions/CreateActionPlanRequest" } }, { "name": "mode", "in": "query", "required": false, "type": "string", "enum": [ "PREVIEW" ], "x-docgen-enum-table-extension": [ { "value": "PREVIEW", "description": "Returns the plan without creating or executing it." } ], "description": "The mode of operation. Set `PREVIEW` to return the plan without creating or executing it. Omit `mode` to create the plan and submit it for execution.", "x-example": "PREVIEW" }, { "name": "locale", "in": "query", "required": false, "type": "string", "description": "The locale for localized content, as an ISO 639 language code and ISO 3166 country code separated by a hyphen. Defaults to `en-US`.", "x-example": "en-US" } ], "responses": { "200": { "description": "If `mode=PREVIEW` is set, returns a preview of the action plan. Otherwise, returns the created plan, which is submitted for execution.", "schema": { "$ref": "#/definitions/GetActionPlanResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." } }, "examples": { "application/json": { "plan": { "actionPlanId": "e5f6a7b8-89ab-cdef-0123-456789abcdef", "status": [ "DRAFT" ], "displayName": { "text": "Expand FBA to DE — Order #12345", "locale": "en-US" } } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "mode": { "value": "PREVIEW" } } }, "response": { "plan": { "actionPlanId": "e5f6a7b8-89ab-cdef-0123-456789abcdef", "status": [ "DRAFT" ], "displayName": { "text": "Expand FBA to DE — Order #12345", "locale": "en-US" } } } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "planTemplateId": "INVALID" } } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid planTemplateId." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "409": { "description": "The request conflicts with the current state of the resource.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "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/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "get": { "operationId": "listActionPlans", "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "summary": "List action plans.", "description": "Returns a paginated list of the seller's action plans, sorted newest first by `createdDate`. Multiple filters are combined with a logical AND. Multiple values in a single filter are combined with a logical OR.", "tags": [ "actionPlans" ], "parameters": [ { "name": "statuses", "in": "query", "required": false, "type": "array", "items": { "type": "string", "enum": [ "DRAFT", "PENDING_SELLING_PARTNER", "PROCESSING", "DONE", "CANCELLED", "PARTIAL" ] }, "collectionFormat": "csv", "description": "Filters by plan status.", "x-example": "PROCESSING,DONE" }, { "name": "planTemplateIds", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "Filters by plan template IDs. Multiple values allowed.", "x-example": "CROSS_STORE_EXPANSION_FBA" }, { "name": "actionItemIds", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv", "description": "Filters by associated action item IDs. Multiple values allowed.", "x-example": "ebf5caf1-8cfb-43bd-a13b-ef91bdb0d930" }, { "name": "createdAfter", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Plans created at or after this timestamp. Timestamp is in ISO 8601 format.", "x-example": "2025-07-01T00:00:00Z" }, { "name": "createdBefore", "in": "query", "required": false, "type": "string", "format": "date-time", "description": "Plans created at or before this timestamp. Timestamp is in ISO 8601 format.", "x-example": "2025-07-31T23:59:59Z" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "maximum": 20, "default": 10, "description": "Maximum number of results per page.", "x-example": 10 }, { "name": "pageToken", "in": "query", "required": false, "type": "string", "description": "A token to retrieve a specific page of results. Pass the `nextToken` value from a previous response.\n\n**Note:** The `previousToken` value is not yet supported.", "x-example": "eyJsYXN0UGxhbklkIjoiYzFkMmUzZjQifQ==" }, { "name": "locale", "in": "query", "required": false, "type": "string", "description": "The locale for localized content, as an ISO 639 language code and ISO 3166 country code separated by a hyphen. Defaults to `en-US`.", "x-example": "en-US" }, { "name": "includedData", "in": "query", "required": false, "type": "array", "items": { "type": "string", "enum": [ "steps", "refinements" ] }, "collectionFormat": "csv", "description": "Additional data to return in the response. Specify `steps` to return each plan's steps with their resolved input and output values.", "x-example": "steps", "x-docgen-enum-table-extension": [ { "value": "steps", "description": "Include each plan's steps with their resolved input and output values." }, { "value": "refinements", "description": "Include search refinements (facets) for progressive filtering based on the current result set. This value is not yet supported." } ] } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ListActionPlansResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." } }, "examples": { "application/json": { "actionPlans": [ { "actionPlanId": "e5f6a7b8-89ab-cdef-0123-456789abcdef", "type": { "definition": { "planDefinitionId": "CROSS_STORE_EXPANSION_FBA", "displayName": { "text": "Cross-store expansion (FBA)", "locale": "en-US" } } }, "displayName": { "text": "Expand FBA to DE — Order #12345", "locale": "en-US" }, "status": [ "PROCESSING" ], "inputs": { "sourceMarketplaceId": { "value": [ "A1PA6795UKMFR9" ] }, "targetMarketplaceId": { "value": [ "A13V1IB3VIYZZH" ] } }, "createdDate": "2025-07-07T14:55:00Z", "lastUpdatedDate": "2025-07-07T16:00:00Z", "startedDate": "2025-07-07T15:01:00Z" } ], "numberOfResults": 5, "pagination": { "nextToken": "eyJsYXN0UGxhbklkIjoiYzFkMmUzZjQifQ==" } } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": {} }, "response": { "actionPlans": [ { "actionPlanId": "e5f6a7b8-89ab-cdef-0123-456789abcdef", "status": [ "PROCESSING" ] } ], "numberOfResults": 1, "pagination": {} } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "statuses": { "value": [ "INVALID" ] } } }, "response": { "errors": [ { "code": "InvalidInput", "message": "Invalid status value: INVALID." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "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/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } } }, "definitions": { "ActionItem": { "description": "An issue or required action on a specific step surfaced during plan creation or execution.", "type": "object", "required": [ "type", "description" ], "properties": { "type": { "description": "The classification of this action item and a reference to its type definition.", "$ref": "#/definitions/ActionItemType" }, "description": { "description": "Localized description of the action item.", "$ref": "#/definitions/LocalizedText" }, "references": { "description": "The steps and attributes within the plan that this action item relates to.", "$ref": "#/definitions/ActionItemReferences" } }, "example": { "type": { "classifications": [ "ISSUE" ], "definition": { "typeDefinitionId": "MISSING_INPUT", "displayName": { "text": "Missing Input", "locale": "en-US" } } }, "description": { "text": "Step 'Copy Offers' is missing value for sourceMarketplaceId input.", "locale": "en-US" }, "references": { "steps": [ { "stepId": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "attributeNames": [ "sourceMarketplaceId" ] } ] } } }, "ActionItemReference": { "description": "A reference from a plan to the action item it resolves.", "type": "object", "required": [ "actionItemId" ], "properties": { "actionItemId": { "description": "The identifier of the action item this plan resolves.", "type": "string", "example": "ebf5caf1-8cfb-43bd-a13b-ef91bdb0d930" }, "resolution": { "description": "The resolution on the action item that this plan fulfills.", "$ref": "#/definitions/ActionItemResolutionRef" } } }, "ActionItemResolutionReference": { "description": "Identifies the action item this plan resolves and the resolution it fulfills. Required when creating a plan from an action item.", "type": "object", "required": [ "actionItemId", "resolution" ], "properties": { "actionItemId": { "description": "The identifier of the action item this plan resolves.", "type": "string", "example": "ebf5caf1-8cfb-43bd-a13b-ef91bdb0d930" }, "resolution": { "description": "The resolution on the action item that this plan fulfills.", "$ref": "#/definitions/ActionItemResolutionRef" } } }, "ActionItemReferences": { "description": "Contains an action item's references to steps and attributes.", "type": "object", "properties": { "steps": { "description": "The steps this action item relates to.", "type": "array", "items": { "$ref": "#/definitions/ActionItemStepReference" } } }, "example": { "steps": [ { "stepId": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "attributeNames": [ "sourceMarketplaceId" ] } ] } }, "ActionItemStepReference": { "description": "A reference from an action item to a specific step and its affected attributes.", "type": "object", "required": [ "stepId" ], "properties": { "stepId": { "description": "The step identifier (UUID) this action item relates to.", "type": "string", "example": "7c9e6679-7425-40de-944b-e07fc1f90ae7" }, "attributeNames": { "description": "The input or output attribute names on the step that this action item relates to.", "type": "array", "items": { "type": "string" }, "example": [ "sourceMarketplaceId" ] } }, "example": { "stepId": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "attributeNames": [ "sourceMarketplaceId" ] } }, "ActionItemType": { "description": "Combines one or more classifications with a reference to the action item's type definition.", "type": "object", "required": [ "classifications", "definition" ], "properties": { "classifications": { "description": "One or more classifications for this action item.", "$ref": "#/definitions/ActionItemTypeClassifications" }, "definition": { "description": "The action item's type definition.", "$ref": "#/definitions/ActionItemTypeDefinition" } }, "example": { "classifications": [ "ISSUE" ], "definition": { "typeDefinitionId": "MISSING_INPUT", "displayName": { "text": "Missing Input", "locale": "en-US" } } } }, "ActionItemTypeClassification": { "description": "A classification of an action item.", "type": "string", "enum": [ "ISSUE", "TASK", "RECOMMENDATION" ], "example": "ISSUE", "x-docgen-enum-table-extension": [ { "value": "ISSUE", "description": "A problem to fix." }, { "value": "TASK", "description": "An item requiring seller action." }, { "value": "RECOMMENDATION", "description": "An opportunity to pursue." } ] }, "ActionItemTypeClassifications": { "description": "Classifications for an action item type.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/ActionItemTypeClassification" }, "example": [ "ISSUE" ] }, "ActionItemTypeDefinition": { "description": "The action item's type and its display name.", "type": "object", "required": [ "typeDefinitionId", "displayName" ], "properties": { "typeDefinitionId": { "description": "The semantic identifier of the action item type definition.", "type": "string", "example": "MISSING_INPUT" }, "displayName": { "description": "Localized display name of the action item type.", "$ref": "#/definitions/LocalizedText" } }, "example": { "typeDefinitionId": "MISSING_INPUT", "displayName": { "text": "Missing Input", "locale": "en-US" } } }, "ActionPlan": { "description": "An action plan instance.", "type": "object", "required": [ "actionPlanId", "status" ], "properties": { "actionPlanId": { "description": "Unique identifier for this action plan (UUID, system-generated).", "type": "string", "example": "e5f6a7b8-89ab-cdef-0123-456789abcdef" }, "type": { "description": "The plan template this plan instantiates.", "$ref": "#/definitions/ActionPlanType" }, "references": { "description": "Entities related to this plan.", "$ref": "#/definitions/PlanReferences" }, "status": { "description": "Current lifecycle state of the plan.", "$ref": "#/definitions/PlanStatuses" }, "inputs": { "description": "Input values for the plan, keyed by name. Omitted when empty.", "$ref": "#/definitions/InputValues" }, "createdDate": { "description": "When the plan was created, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-07-07T14:55:00Z" }, "lastUpdatedDate": { "description": "When the plan was last updated, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-07-07T17:00:00Z" }, "acceptedDate": { "description": "When the plan was accepted, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-07-07T15:00:00Z" }, "completedDate": { "description": "When the plan reached a terminal state, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-07-07T17:00:00Z" }, "steps": { "description": "The plan's steps with their resolved input and output values. Included only when `includedData` contains `steps`.", "type": "array", "items": { "$ref": "#/definitions/PlanStep" } }, "startedDate": { "description": "When execution began, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-07-07T15:01:00Z" }, "displayName": { "description": "System-generated localized display name for the plan (read-only).", "$ref": "#/definitions/LocalizedText" }, "actionItems": { "description": "Action items generated during plan creation or execution. Follows the same schema as the Action Items API.", "type": "array", "items": { "$ref": "#/definitions/ActionItem" } } }, "example": { "actionPlanId": "e5f6a7b8-89ab-cdef-0123-456789abcdef", "type": { "definition": { "displayName": { "text": "Cross-store expansion (FBA)", "locale": "en-US" }, "planDefinitionId": "CROSS_STORE_EXPANSION_FBA" } }, "references": { "actionItems": [ { "actionItemId": "ebf5caf1-8cfb-43bd-a13b-ef91bdb0d930", "resolution": { "definition": { "resolutionDefinitionId": "CROSS_STORE_EXPANSION_FBA" } } } ] }, "displayName": { "text": "Expand FBA to DE — Order #12345", "locale": "en-US" }, "status": [ "DONE" ], "inputs": { "sourceMarketplaceId": { "value": [ "A1PA6795UKMFR9" ] }, "targetMarketplaceId": { "value": [ "A13V1IB3VIYZZH" ] } }, "createdDate": "2025-07-07T14:55:00Z", "lastUpdatedDate": "2025-07-07T17:00:00Z", "acceptedDate": "2025-07-07T15:00:00Z", "startedDate": "2025-07-07T15:01:00Z", "completedDate": "2025-07-07T17:00:00Z" } }, "ActionPlanType": { "description": "The plan template this plan instantiates.", "type": "object", "required": [ "definition" ], "properties": { "definition": { "description": "The plan template.", "$ref": "#/definitions/PlanDefinitionRef" } }, "example": { "definition": { "displayName": { "text": "Cross-store expansion (FBA)", "locale": "en-US" }, "planDefinitionId": "CROSS_STORE_EXPANSION_FBA" } } }, "CreateActionPlanRequest": { "description": "Request body for creating an action plan.", "type": "object", "required": [ "planTemplateId" ], "properties": { "planTemplateId": { "description": "The plan template to instantiate.", "type": "string", "example": "CROSS_STORE_EXPANSION_FBA" }, "actionItem": { "description": "The action item this plan addresses. When provided, inputs may be prepopulated from the action item context.", "$ref": "#/definitions/ActionItemResolutionReference" }, "inputs": { "description": "Input values for the plan, keyed by name. Each entry is an object with a `value` property containing an array of strings.", "$ref": "#/definitions/InputValues" } }, "example": { "planTemplateId": "CROSS_STORE_EXPANSION_FBA", "actionItem": { "actionItemId": "ebf5caf1-8cfb-43bd-a13b-ef91bdb0d930", "resolution": { "definition": { "resolutionDefinitionId": "CROSS_STORE_EXPANSION_FBA" } } }, "inputs": { "sourceMarketplaceId": { "value": [ "A1PA6795UKMFR9" ] }, "targetMarketplaceId": { "value": [ "A13V1IB3VIYZZH" ] } } } }, "Error": { "description": "Error response returned when the request is unsuccessful.", "type": "object", "required": [ "code", "message" ], "properties": { "code": { "description": "An error code that identifies the type of error that occurred.", "type": "string" }, "message": { "description": "A message that describes the error condition.", "type": "string" }, "details": { "description": "Additional details that can help the caller understand or fix the issue.", "type": "string", "example": "The actionPlanId must be a valid UUID." } } }, "ErrorList": { "description": "A list of error responses returned when a request is unsuccessful.", "type": "object", "required": [ "errors" ], "properties": { "errors": { "description": "Error list.", "type": "array", "items": { "$ref": "#/definitions/Error" } } } }, "GetActionPlanResponse": { "description": "Response for the getActionPlan operation, containing the requested action plan.", "type": "object", "required": [ "plan" ], "properties": { "plan": { "description": "The action plan.", "$ref": "#/definitions/ActionPlan" } }, "example": { "plan": { "actionPlanId": "e5f6a7b8-89ab-cdef-0123-456789abcdef", "status": [ "DONE" ], "displayName": { "text": "Expand FBA to DE — Order #12345", "locale": "en-US" } } } }, "InputDeclaration": { "description": "A display-name declaration for a named input or output.", "type": "object", "required": [ "displayName" ], "properties": { "displayName": { "description": "Localized display name for this input or output.", "$ref": "#/definitions/LocalizedText" } }, "example": { "displayName": { "text": "Source marketplace ID", "locale": "en-US" } } }, "InputDeclarations": { "description": "A map of input or output declarations, keyed by name.", "type": "object", "additionalProperties": { "$ref": "#/definitions/InputDeclaration" }, "example": { "sourceMarketplaceId": { "displayName": { "text": "Source marketplace ID", "locale": "en-US" } } } }, "InputValue": { "description": "An input or output value carried as an array of strings.", "type": "object", "required": [ "value" ], "properties": { "value": { "description": "The value, as an array of strings.", "type": "array", "items": { "type": "string" }, "example": [ "A1PA6795UKMFR9" ] } }, "example": { "value": [ "A1PA6795UKMFR9" ] } }, "InputValues": { "description": "A map of input or output values, keyed by name.", "type": "object", "additionalProperties": { "$ref": "#/definitions/InputValue" }, "example": { "sourceMarketplaceId": { "value": [ "A1PA6795UKMFR9" ] }, "targetMarketplaceId": { "value": [ "A13V1IB3VIYZZH" ] } } }, "ListActionPlansResponse": { "description": "Response for the `listActionPlans` operation, containing the matching action plans and the total results count.", "type": "object", "required": [ "actionPlans", "numberOfResults" ], "properties": { "actionPlans": { "description": "The action plans matching the query. Steps are omitted by default.", "type": "array", "items": { "$ref": "#/definitions/ActionPlan" } }, "numberOfResults": { "description": "The total number of action plans matching the query.", "type": "integer" }, "refinements": { "description": "Search refinements for progressive filtering. Returned only when `includedData` contains `refinements`. This value is not yet supported.", "$ref": "#/definitions/SearchRefinements" }, "pagination": { "description": "Pagination metadata.", "$ref": "#/definitions/Pagination" } }, "example": { "actionPlans": [ { "actionPlanId": "e5f6a7b8-89ab-cdef-0123-456789abcdef", "status": [ "PROCESSING" ] } ], "numberOfResults": 2, "refinements": { "planTemplateId": [ { "displayName": "Cross-store expansion (FBA)", "count": 12, "value": "CROSS_STORE_EXPANSION_FBA" } ] }, "pagination": { "nextToken": "eyJsYXN0UGxhbklkIjoiYzFkMmUzZjQifQ==" } } }, "SearchRefinements": { "description": "Facets keyed by refinement name, used for progressive filtering of the result set.", "type": "object", "additionalProperties": { "$ref": "#/definitions/SearchRefinementValues" }, "example": { "planTemplateId": [ { "displayName": "Cross-store expansion (FBA)", "count": 12, "value": "CROSS_STORE_EXPANSION_FBA" } ] } }, "SearchRefinementValues": { "description": "The set of values available for a single search refinement.", "type": "array", "items": { "$ref": "#/definitions/SearchRefinementValue" }, "example": [ { "displayName": "Cross-store expansion (FBA)", "count": 12, "value": "CROSS_STORE_EXPANSION_FBA" } ] }, "SearchRefinementValue": { "description": "A single search refinement value with its display name and result count.", "type": "object", "required": [ "displayName", "count", "value" ], "properties": { "displayName": { "description": "The localized display name for this refinement value.", "type": "string", "example": "Cross-store expansion (FBA)" }, "count": { "description": "The number of results matching this refinement value.", "type": "integer", "example": 12 }, "value": { "description": "The value to supply as a filter to refine the result set.", "type": "string", "example": "CROSS_STORE_EXPANSION_FBA" } } }, "LocalizedText": { "description": "A localized text value paired with the locale it is rendered in.", "type": "object", "required": [ "text", "locale" ], "properties": { "text": { "description": "The localized text content.", "type": "string", "example": "Cross-store expansion (FBA)" }, "locale": { "description": "The BCP 47 language tag, as an ISO 639 language code and ISO 3166 country code separated by a hyphen.", "type": "string", "example": "en-US" } } }, "Pagination": { "description": "Cursor-based pagination metadata.", "type": "object", "properties": { "nextToken": { "description": "Token to retrieve the next page. Absent when no more results.", "type": "string", "example": "eyJsYXN0UGxhbklkIjoiYzFkMmUzZjQifQ==" }, "previousToken": { "description": "A token to retrieve the previous page of results. This value is not yet supported.", "type": "string", "example": "eyJsYXN0UGxhbklkIjoiYTliOGM3ZDYifQ==" } }, "example": { "nextToken": "eyJsYXN0UGxhbklkIjoiYzFkMmUzZjQifQ==" } }, "PlanDefinitionRef": { "description": "The plan template and its input declarations.", "type": "object", "required": [ "planDefinitionId", "displayName" ], "properties": { "displayName": { "description": "Localized display name of the plan template.", "$ref": "#/definitions/LocalizedText" }, "inputs": { "description": "Input declarations for the plan, keyed by input name.", "$ref": "#/definitions/InputDeclarations" }, "planDefinitionId": { "description": "The semantic identifier of the plan template.", "type": "string", "example": "CROSS_STORE_EXPANSION_FBA" } }, "example": { "displayName": { "text": "Cross-store expansion (FBA)", "locale": "en-US" }, "inputs": { "sourceMarketplaceId": { "displayName": { "text": "Source marketplace ID", "locale": "en-US" } } }, "planDefinitionId": "CROSS_STORE_EXPANSION_FBA" } }, "PlanReferences": { "description": "Contains entities related to a plan.", "type": "object", "properties": { "actionItems": { "description": "Action items associated with this plan.", "type": "array", "items": { "$ref": "#/definitions/ActionItemReference" } } }, "example": { "actionItems": [ { "actionItemId": "ebf5caf1-8cfb-43bd-a13b-ef91bdb0d930", "resolution": { "definition": { "resolutionDefinitionId": "CROSS_STORE_EXPANSION_FBA" } } } ] } }, "PlanStatus": { "description": "A lifecycle state of an action plan.", "type": "string", "enum": [ "DRAFT", "PENDING_SELLING_PARTNER", "PROCESSING", "DONE", "CANCELLED", "PARTIAL" ], "example": "DONE", "x-docgen-enum-table-extension": [ { "value": "DRAFT", "description": "The plan has been created but not submitted for execution." }, { "value": "PENDING_SELLING_PARTNER", "description": "The plan is awaiting action from the seller." }, { "value": "PROCESSING", "description": "The plan is being executed." }, { "value": "DONE", "description": "The plan finished, and all steps completed successfully." }, { "value": "CANCELLED", "description": "The plan was cancelled before completion." }, { "value": "PARTIAL", "description": "The plan finished, but not all steps completed successfully." } ] }, "PlanStatuses": { "description": "The state of a plan, expressed as an array.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/PlanStatus" }, "example": [ "DONE" ] }, "PlanStep": { "description": "A step instance within a plan.", "type": "object", "required": [ "stepId", "mode", "definition" ], "properties": { "stepId": { "description": "Opaque unique identifier of this step within the plan (UUID).", "type": "string", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "mode": { "description": "Whether this step completes automatically or requires manual seller action.", "$ref": "#/definitions/StepMode" }, "definition": { "description": "The step template this step instantiates.", "$ref": "#/definitions/StepDefinitionRef" }, "description": { "description": "Localized description of the step.", "$ref": "#/definitions/LocalizedText" }, "dependencies": { "description": "Step identifiers (UUIDs) that must complete before this step runs.", "type": "array", "items": { "type": "string" }, "example": [] }, "status": { "description": "The current state of the step. A step can take up to 7 days to complete.", "$ref": "#/definitions/StepStatuses" }, "lastUpdatedDate": { "description": "When the step was last updated, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-07-07T15:15:00Z" }, "completedDate": { "description": "When the step completed, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-07-07T15:15:00Z" }, "inputs": { "description": "Resolved input values for this step, keyed by input name.", "$ref": "#/definitions/InputValues" }, "outputs": { "description": "Produced output values, keyed by output name.", "$ref": "#/definitions/InputValues" }, "startedDate": { "description": "When the step started execution, in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-07-07T15:01:00Z" } }, "example": { "stepId": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "mode": "AUTOMATED", "definition": { "displayName": { "text": "Configure Pricing Settings", "locale": "en-US" }, "stepDefinitionId": "CONFIGURE_PRICING_SETTINGS" }, "description": { "text": "Set up cross-store pricing rules.", "locale": "en-US" }, "dependencies": [], "status": [ "COMPLETED", "SUCCEEDED" ], "startedDate": "2025-07-07T15:01:00Z" } }, "StepDefinitionRef": { "description": "The step template and its input and output declarations.", "type": "object", "required": [ "stepDefinitionId", "displayName" ], "properties": { "displayName": { "description": "Localized display name of the step definition.", "$ref": "#/definitions/LocalizedText" }, "inputs": { "description": "Input declarations for the step, keyed by name.", "$ref": "#/definitions/InputDeclarations" }, "outputs": { "description": "Output declarations for the step, keyed by name.", "$ref": "#/definitions/InputDeclarations" }, "stepDefinitionId": { "description": "The semantic identifier of the step definition.", "type": "string", "example": "CONFIGURE_PRICING_SETTINGS" } }, "example": { "displayName": { "text": "Configure Pricing Settings", "locale": "en-US" }, "stepDefinitionId": "CONFIGURE_PRICING_SETTINGS" } }, "StepMode": { "description": "Indicates whether a step completes automatically or through manual seller action.", "type": "string", "enum": [ "AUTOMATED", "MANUAL" ], "example": "AUTOMATED", "x-docgen-enum-table-extension": [ { "value": "AUTOMATED", "description": "Amazon completes this step automatically, without seller intervention." }, { "value": "MANUAL", "description": "Step requires explicit seller action to complete." } ] }, "StepStatus": { "description": "The current state of the step. A step can take up to 7 days to complete.", "type": "string", "enum": [ "NOT_STARTED", "PENDING_DEPENDENCY", "PENDING_SELLING_PARTNER", "PROCESSING", "COMPLETED", "SKIPPED", "SUCCEEDED", "FAILED" ], "example": "COMPLETED", "x-docgen-enum-table-extension": [ { "value": "NOT_STARTED", "description": "Step has not yet started." }, { "value": "PENDING_DEPENDENCY", "description": "Waiting for upstream dependencies to complete." }, { "value": "PENDING_SELLING_PARTNER", "description": "Awaiting seller action on a manual step." }, { "value": "PROCESSING", "description": "Step is actively executing." }, { "value": "COMPLETED", "description": "Step has reached a terminal state. Paired with an outcome (`SUCCEEDED` or `FAILED`)." }, { "value": "SKIPPED", "description": "Step was skipped." }, { "value": "SUCCEEDED", "description": "Terminal outcome: step completed successfully." }, { "value": "FAILED", "description": "Terminal outcome: step failed." } ] }, "StepStatuses": { "description": "The state of a step, expressed as an array.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/StepStatus" }, "example": [ "COMPLETED", "SUCCEEDED" ] }, "ResolutionDefinitionRef": { "description": "The resolution definition on an action item.", "type": "object", "required": [ "resolutionDefinitionId" ], "properties": { "resolutionDefinitionId": { "description": "The identifier of the resolution definition.", "type": "string", "example": "CROSS_STORE_EXPANSION_FBA" } } }, "ActionItemResolutionRef": { "description": "The resolution definition that satisfies an action item.", "type": "object", "required": [ "definition" ], "properties": { "definition": { "description": "The resolution definition.", "$ref": "#/definitions/ResolutionDefinitionRef" } } } } }