{
  "openapi": "3.0.1",
  "info": {
    "title": "MerchantSpring Public API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://mm-api.merchantspring.io",
      "description": "Production"
    },
    {
      "url": "https://mm-api-staging.merchantspring.io",
      "description": "Staging"
    }
  ],
  "tags": [
    {
      "name": "advertising",
      "x-group": "Advertising"
    },
    {
      "name": "channel",
      "x-group": "Channel"
    },
    {
      "name": "content-change",
      "x-group": "Content Change"
    },
    {
      "name": "custom-group",
      "x-group": "Custom Group"
    },
    {
      "name": "order",
      "x-group": "Order"
    },
    {
      "name": "product",
      "x-group": "Product"
    },
    {
      "name": "report",
      "x-group": "Report"
    },
    {
      "name": "vendor",
      "x-group": "Vendor"
    },
    {
      "name": "tag",
      "x-group": "Tag"
    },
    {
      "name": "search-query-performance",
      "x-group": "Search Query Performance"
    },
    {
      "name": "client-report",
      "x-group": "Client Report"
    },
    {
      "name": "profitability",
      "x-group": "Profitability"
    },
    {
      "name": "targets",
      "x-group": "Targets"
    },
    {
      "name": "seller-health",
      "x-group": "Seller Health"
    }
  ],
  "paths": {
    "/channels": {
      "post": {
        "tags": ["channel"],
        "summary": "Retrieve a list of channels",
        "description": "Retrieve a list of channels that match the specified filter criteria",
        "operationId": "getChannels",
        "requestBody": {
          "description": "Filter criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetChannelsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ArrayOfChannel"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "malformedFilter": {
                    "summary": "filter.marketplaces / filter.countryCodes is not an array of strings",
                    "value": { "status": "error", "error": "Invalid filter parameters" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/clientReports": {
      "get": {
        "tags": ["client-report"],
        "summary": "List all sent and scheduled client reports",
        "description": "Retrieve a paginated list of client-deliverable reports that have been sent and/or are currently scheduled, each annotated with its sent/scheduled status and a link to view it. Saved report configurations that have never been sent or scheduled are excluded. Visibility is scoped by the caller's role: administrators and owners see every user's reports in the organisation, other roles see only their own. Sorted by createdAt descending unless sortKey/sortOrder are given. Requires the reportsOn entitlement on the API key's associated account.",
        "operationId": "listReports",
        "parameters": [
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0). A page beyond the last one returns 200 with an empty data array, not an error.",
            "schema": { "type": "integer", "minimum": 0, "default": 0 }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of results per page, max 100 (default 10).",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 10
            }
          },
          {
            "name": "sortKey",
            "in": "query",
            "description": "Response column to sort by (default createdAt).",
            "schema": {
              "type": "string",
              "enum": ["createdAt", "reportName"],
              "default": "createdAt"
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort direction (default desc).",
            "schema": {
              "type": "string",
              "enum": ["asc", "desc"],
              "default": "desc"
            }
          },
          {
            "name": "reportName",
            "in": "query",
            "description": "Filter by report name (partial match)",
            "schema": { "type": "string" }
          },
          {
            "name": "channelId",
            "in": "query",
            "description": "Filter to reports configured for this store/channel. Not applicable for multi-channel reports, which are grouped by tag rather than a fixed set of channels.",
            "schema": { "type": "string" }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Filter to reports configured for this merchant ID",
            "schema": { "type": "string" }
          },
          {
            "name": "recipientEmail",
            "in": "query",
            "description": "Only show reports that are scheduled to, or have been sent to, this email address.",
            "schema": { "type": "string" }
          },
          {
            "name": "isSent",
            "in": "query",
            "description": "Filter to reports that have (or have not) ever been sent. Can be combined with isScheduled: isSent=true&isScheduled=true - sent and still scheduled; isSent=true&isScheduled=false - sent but no longer scheduled; isSent=false&isScheduled=true - scheduled but never sent; isSent=false&isScheduled=false - always empty.",
            "schema": { "type": "boolean" }
          },
          {
            "name": "isScheduled",
            "in": "query",
            "description": "Filter to reports that are (or are not) currently scheduled. Can be combined with isSent: isSent=true&isScheduled=true - sent and still scheduled; isSent=true&isScheduled=false - sent but no longer scheduled; isSent=false&isScheduled=true - scheduled but never sent; isSent=false&isScheduled=false - always empty.",
            "schema": { "type": "boolean" }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Start of date range, as Unix epoch seconds (not milliseconds). Filters on when the report record was created , not the date range the report's own data covers (see reportingPeriod in the response). Defaults to 30 days ago.",
            "required": false,
            "schema": { "type": "integer" }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "End of date range, as Unix epoch seconds (not milliseconds). Filters on when the report record was created , not the date range the report's own data covers (see reportingPeriod in the response). Defaults to now. The range must not exceed 6 months; passing milliseconds instead of seconds is a common cause of an unexpected \"Date range must not exceed 6 months\" error.",
            "required": false,
            "schema": { "type": "integer" }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": { "schema": { "type": "string" } }
            },
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ListReportsResponse" }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "invalidSortKey": {
                    "summary": "sortKey is not one of the supported values",
                    "value": {
                      "status": "error",
                      "error": "sortKey must be one of: createdAt, reportName"
                    }
                  },
                  "invalidRecipientEmail": {
                    "summary": "recipientEmail is not a valid email address",
                    "value": {
                      "status": "error",
                      "error": "recipientEmail must be a valid email"
                    }
                  },
                  "invalidPageSize": {
                    "summary": "pageSize is not a positive integer",
                    "value": {
                      "status": "error",
                      "error": "pageSize must be a positive integer"
                    }
                  },
                  "invalidDateRange": {
                    "summary": "toDate is before fromDate",
                    "value": {
                      "status": "error",
                      "error": "toDate must not be before fromDate"
                    }
                  },
                  "dateRangeTooWide": {
                    "summary": "fromDate/toDate range exceeds 6 months",
                    "value": {
                      "status": "error",
                      "error": "Date range must not exceed 6 months"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Either a missing/invalid x-api-key, or an authenticated account that lacks the Client Reports entitlement. The two cases have different response shapes - see examples.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    { "$ref": "#/components/schemas/ErrorResponse" },
                    { "$ref": "#/components/schemas/ApiGatewayForbiddenResponse" }
                  ]
                },
                "examples": {
                  "notEntitled": {
                    "summary": "Account has no Client Reports (reportsOn) entitlement",
                    "value": {
                      "status": "error",
                      "error": "Unauthorized: account does not have permission to access this endpoint"
                    }
                  },
                  "invalidApiKey": {
                    "summary": "Missing or invalid x-api-key",
                    "value": { "message": "Forbidden" }
                  }
                }
              }
            }
          }
        },
        "security": [{ "api_key": [] }]
      }
    },
    "/content-changes": {
      "post": {
        "tags": ["content-change"],
        "summary": "Retrieve a list of content changes",
        "description": "Retrieve a paginated list of product content changes for a given store. Returns one record per product with per-field change status, original value, benchmark value and last-changed timestamp. Page size is capped at 500 items per request. Uses zero-based page indexing (pageIndex starts at 0).",
        "operationId": "getContentChanges",
        "requestBody": {
          "description": "Filter and pagination criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetContentChangesRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetContentChangesResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "missingParam": {
                    "summary": "A required body field is missing",
                    "value": { "status": "error", "error": "Missing parameter in request body: mid" }
                  },
                  "invalidPageSize": {
                    "summary": "paginationParams.pageSize is not a positive integer",
                    "value": { "status": "error", "error": "Invalid parameter: paginationParams.pageSize must be a positive integer" }
                  },
                  "invalidPageIndex": {
                    "summary": "paginationParams.pageIndex is not a non-negative integer",
                    "value": { "status": "error", "error": "Invalid parameter: paginationParams.pageIndex must be a non-negative integer" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/products/amazon": {
      "get": {
        "tags": ["product"],
        "summary": "Retrieve Amazon product attributes",
        "description": "Returns catalog attributes for an Amazon seller or vendor ASIN, together with seller listing data or vendor details when available.",
        "operationId": "getProductAttribute",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel (store) ID. Must be an Amazon seller or vendor channel.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID that owns the channel. URL-encode values containing spaces or '@'.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "asin",
            "in": "query",
            "description": "Amazon Standard Identification Number. Must contain exactly 10 letters or numbers. Lowercase input is normalized to uppercase.",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 10,
              "maxLength": 10,
              "pattern": "^[A-Z0-9]{10}$",
              "example": "B0020MMCJI"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProductAttributeResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input or unsupported channel",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "missingParameter": {
                    "summary": "A required query parameter is missing",
                    "value": {
                      "status": "error",
                      "error": "Asin is required"
                    }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId did not resolve to a channel",
                    "value": {
                      "status": "error",
                      "error": "Invalid channelId / merchantId"
                    }
                  },
                  "unsupportedChannel": {
                    "summary": "Channel is not an Amazon seller or vendor channel",
                    "value": {
                      "status": "error",
                      "error": "This endpoint is only supported for Amazon channels"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "The user does not have access to the specified store",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "example": {
                  "status": "error",
                  "error": "user does not have access to specified store"
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/search-query-performance/asins": {
      "get": {
        "tags": ["search-query-performance"],
        "summary": "Retrieve Search Query Performance data at the ASIN level (Amazon only)",
        "description": "Returns aggregated Search Query Performance metrics (impressions, clicks, cart adds, purchases and derived rates/shares) per ASIN, compared against a prior period. If 'asins' is omitted, the top ASINs by impression volume are resolved automatically, capped to the organisation's Search Query Performance entitlement. Monetary values are converted into the requested currency. Requires the organisation to have Search Query Performance access enabled.",
        "operationId": "getSqpAsinTable",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel (store) ID. Must be an Amazon seller or vendor channel.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID that owns the channel. URL-encode values containing spaces or '@'.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Unix epoch time (seconds) representing the start of the reporting period. SQP data is only available at monthly granularity, so this is clipped to the start of its containing calendar month; the clipped date is returned as meta.dateRange.fromDate in the response.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "Unix epoch time (seconds) representing the end of the reporting period. SQP data is only available at monthly granularity, so this is clipped to the end of its containing calendar month; the clipped date is returned as meta.dateRange.toDate in the response.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "priorFromDate",
            "in": "query",
            "description": "Unix epoch time (seconds) representing the start of the comparison period. SQP data is only available at monthly granularity, so this is clipped to the start of its containing calendar month; the clipped date is returned as meta.dateRange.priorFromDate in the response.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "priorToDate",
            "in": "query",
            "description": "Unix epoch time (seconds) representing the end of the comparison period. SQP data is only available at monthly granularity, so this is clipped to the end of its containing calendar month; the clipped date is returned as meta.dateRange.priorToDate in the response.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "timezone",
            "in": "query",
            "description": "IANA timezone identifier used to bucket the date range, for example Australia/Sydney.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of results per page (default 25, max 50).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "default": 25
            }
          },
          {
            "name": "sortKey",
            "in": "query",
            "description": "Field to sort by (default searchQueryVolume).",
            "required": false,
            "schema": {
              "type": "string",
              "default": "searchQueryVolume",
              "enum": [
                "asin",
                "searchQueryVolume",
                "totalImpressions",
                "impressions",
                "impressionShare",
                "totalClicks",
                "clicks",
                "clickShare",
                "totalCtr",
                "ctr",
                "totalCartAdds",
                "cartAdds",
                "atcRate",
                "totalPurchases",
                "purchases",
                "purchaseShare",
                "totalCvr",
                "cvr",
                "currentRevenue"
              ]
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort direction (default asc).",
            "required": false,
            "schema": {
              "type": "string",
              "default": "asc",
              "enum": ["asc", "desc"]
            }
          },
          {
            "name": "asins",
            "in": "query",
            "description": "(Optional) Restrict results to these ASINs. Repeat the parameter for multiple values, e.g. ?asins=B001&asins=B002. If omitted, the top ASINs by impression volume are resolved automatically, capped to the organisation's Search Query Performance entitlement.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "3-letter ISO currency code to convert monetary values into (default USD).",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetSqpAsinTableResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input or unsupported channel",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "invalidChannel": {
                    "summary": "channelId / merchantId do not match a connected store",
                    "value": {
                      "status": "error",
                      "error": "Invalid channelId / merchantId"
                    }
                  },
                  "nonAmazonChannel": {
                    "summary": "Channel is not an Amazon store",
                    "value": {
                      "status": "error",
                      "error": "This endpoint is only supported for Amazon channels"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "The organisation does not have access to Search Query Performance data",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "notEntitled": {
                    "summary": "Organisation has no Search Query Performance entitlement",
                    "value": {
                      "status": "error",
                      "error": "Your account is not entitled to Search Query Performance data. Please contact sales to enquire about a subscription."
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/search-query-performance/keywords": {
      "get": {
        "tags": ["search-query-performance"],
        "summary": "Retrieve Search Query Performance data at the keyword level for one ASIN (Amazon only)",
        "description": "Returns a paginated list of Search Query Performance metrics per search query (keyword) for a single ASIN, compared against a prior period. Monetary values are converted into the requested currency. Requires the organisation to have Search Query Performance access enabled.",
        "operationId": "getSqpKeywordTable",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel (store) ID. Must be an Amazon seller or vendor channel.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID that owns the channel. URL-encode values containing spaces or '@'.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "asin",
            "in": "query",
            "description": "ASIN to retrieve the keyword-level breakdown for.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Unix epoch time (seconds) representing the start of the reporting period. SQP data is only available at monthly granularity, so this is clipped to the start of its containing calendar month; the clipped date is returned as meta.dateRange.fromDate in the response.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "Unix epoch time (seconds) representing the end of the reporting period. SQP data is only available at monthly granularity, so this is clipped to the end of its containing calendar month; the clipped date is returned as meta.dateRange.toDate in the response.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "priorFromDate",
            "in": "query",
            "description": "Unix epoch time (seconds) representing the start of the comparison period. SQP data is only available at monthly granularity, so this is clipped to the start of its containing calendar month; the clipped date is returned as meta.dateRange.priorFromDate in the response.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "priorToDate",
            "in": "query",
            "description": "Unix epoch time (seconds) representing the end of the comparison period. SQP data is only available at monthly granularity, so this is clipped to the end of its containing calendar month; the clipped date is returned as meta.dateRange.priorToDate in the response.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "timezone",
            "in": "query",
            "description": "IANA timezone identifier used to bucket the date range, for example Australia/Sydney.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of results per page (default 25, max 50).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "default": 25
            }
          },
          {
            "name": "sortKey",
            "in": "query",
            "description": "Field to sort by (default searchQueryVolume).",
            "required": false,
            "schema": {
              "type": "string",
              "default": "searchQueryVolume",
              "enum": [
                "searchQuery",
                "searchQueryVolume",
                "totalImpressions",
                "impressions",
                "impressionShare",
                "totalClicks",
                "clicks",
                "clickShare",
                "totalCtr",
                "ctr",
                "totalCartAdds",
                "cartAdds",
                "atcRate",
                "totalPurchases",
                "purchases",
                "purchaseShare",
                "totalCvr",
                "cvr",
                "currentRevenue"
              ]
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort direction (default desc).",
            "required": false,
            "schema": {
              "type": "string",
              "default": "desc",
              "enum": ["asc", "desc"]
            }
          },
          {
            "name": "searchText",
            "in": "query",
            "description": "(Optional) Filter search queries containing this text (case-insensitive).",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "3-letter ISO currency code to convert monetary values into (default USD).",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetSqpKeywordTableResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input or unsupported channel",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "invalidChannel": {
                    "summary": "channelId / merchantId do not match a connected store",
                    "value": {
                      "status": "error",
                      "error": "Invalid channelId / merchantId"
                    }
                  },
                  "nonAmazonChannel": {
                    "summary": "Channel is not an Amazon store",
                    "value": {
                      "status": "error",
                      "error": "This endpoint is only supported for Amazon channels"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "The organisation does not have access to Search Query Performance data",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "notEntitled": {
                    "summary": "Organisation has no Search Query Performance entitlement",
                    "value": {
                      "status": "error",
                      "error": "Your account is not entitled to Search Query Performance data. Please contact sales to enquire about a subscription."
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/vendor/asins": {
      "get": {
        "tags": ["vendor"],
        "summary": "Retrieve all vendor fields against an ASIN",
        "description": "Vendor only. Returns one wide row per ASIN combining every data point we hold for the product: catalogue, ordered revenue, shipped revenue (sourcing and manufacturing), inventory health, purchase orders, product profit, sourcing share and advertising. Supply asin to fetch a single product, or omit it to page through the full master list (products with sales activity in the window). The date range must not exceed 30 days. Page size defaults to 20 and is capped at 50 (rows are wide). Uses zero-based page indexing.",
        "operationId": "getAsinDetails",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel (store) ID. Must be an Amazon Vendor channel.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID that owns the channel. URL-encode values containing spaces or '@'.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Start of date range as unix epoch seconds.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "End of date range as unix epoch seconds. The range must not exceed 30 days.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "timezone",
            "in": "query",
            "description": "IANA timezone string, for example Australia/Sydney.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "asin",
            "in": "query",
            "description": "When supplied, returns only this ASIN; otherwise returns the paginated master list.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sortKey",
            "in": "query",
            "description": "Product sales metric to sort by. Unrecognised values fall back to asin.",
            "required": false,
            "schema": {
              "type": "string",
              "default": "asin",
              "enum": [
                "asin",
                "orderedRevenue",
                "orderedUnits",
                "glanceViews",
                "lostFeaturedOffer",
                "shippedRevenue",
                "shippedUnits",
                "shippedCogs",
                "customerReturns",
                "shippedRevenueMfg",
                "shippedCogsMfg"
              ]
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort direction (default asc).",
            "required": false,
            "schema": {
              "type": "string",
              "default": "asc",
              "enum": ["asc", "desc"]
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of ASINs per page (default 20, max 50).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "default": 20
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAsinDetailsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": {
                      "status": "error",
                      "error": "Invalid channelId / merchantId"
                    }
                  },
                  "notVendorChannel": {
                    "summary": "Channel exists but is not an Amazon Vendor channel",
                    "value": {
                      "status": "error",
                      "error": "This endpoint is only supported for vendor channels"
                    }
                  },
                  "dateRangeTooLong": {
                    "summary": "Window exceeds the 30-day maximum",
                    "value": {
                      "status": "error",
                      "error": "toDate and fromDate must be no greater than 30 days apart"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/targets": {
      "get": {
        "tags": ["targets"],
        "summary": "Retrieve budgets and forecasts (Ad Spend Budget, Sales Budget, Sales Forecast)",
        "description": "Returns the sales budget, sales forecast and ad spend budget targets for a channel over a date range. Data is an ordered array with ISO 8601 and Unix epoch start/end times for each period bucket; the number of buckets depends on interval (for example a one-year range with interval=month returns ~12 buckets, interval=week ~52, interval=day ~366). The totals object is the summed roll-up across the whole range.",
        "operationId": "getTargets",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel (store) ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID that owns the channel. URL-encode values containing spaces or '@'.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Start of date range as unix epoch seconds.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "End of date range as unix epoch seconds.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "timezone",
            "in": "query",
            "description": "IANA timezone string, for example Australia/Sydney.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "interval",
            "in": "query",
            "description": "Time bucket size for the data breakdown. day returns one entry per day, week per week, month per month. Defaults to day.",
            "required": false,
            "schema": {
              "type": "string",
              "default": "day",
              "enum": ["day", "week", "month"]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/getTargetsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "Invalid channelId / merchantId" }
                  },
                  "invalidDateOrder": {
                    "summary": "toDate is before fromDate",
                    "value": { "status": "error", "error": "toDate must not be before fromDate" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/orders/amazon": {
      "post": {
        "tags": ["order"],
        "summary": "Retrieve a list of orders for an Amazon channel (Requires Enterprise plan)",
        "description": "Retrieve a list of orders for an Amazon channel that match the specified filter criteria. \n\n**NOTE: This endpoint is only available to users on the Enterprise plan.**",
        "operationId": "getOrders",
        "requestBody": {
          "description": "Filter criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetOrdersRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetOrdersResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "missingParam": {
                    "summary": "A required body field is missing",
                    "value": { "status": "error", "error": "Missing parameter in request body: channelId" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "Invalid channelId / merchantId" }
                  },
                  "notAmazonChannel": {
                    "summary": "Channel exists but is not an Amazon store",
                    "value": { "status": "error", "error": "Invalid channelId / merchantId: Only amazon stores are supported for this endpoint" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/salesByProduct": {
      "post": {
        "tags": ["report"],
        "summary": "Create a sales by product report",
        "description": "Create a \"sales by product\" report. The generated report CSV contains the columns defined in the `SalesByProductReportColumns` schema. For Amazon Vendor channels, 'totalSales' is replaced by 'poValue' and 'unitsSold' by 'unitsOrdered'. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createSalesByProductReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateSalesByProductReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/SalesByProductReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/clientReports/generatePDF": {
      "post": {
        "tags": [
          "client-report"
        ],
        "summary": "Generate a PDF of a saved Client Report",
        "description": "Creates a PDF of a saved Client Report, exactly as the report currently appears. This returns a `jobId` straight away - poll GET /clientReports/generatePDF?jobId={jobId} until `status` is \"done\" to get the download link. PDFs are created in turn, so allow up to 5 minutes for one to be ready. If it isn't ready yet, wait a little longer before checking again. The download link is valid for 4 hours.\n\nA new PDF of the same report can be created once an hour: if you already created one in the last 60 minutes, that PDF is returned immediately (`status` \"done\") instead of creating a new one. If a PDF of the same report you requested is still being generated, that job is returned instead of starting another.\n\nOwners and Administrators can create a PDF of any report in their organisation; other roles only of reports they created.",
        "operationId": "createClientReport",
        "requestBody": {
          "description": "Client Report identifier",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateClientReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientReportCreateResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "missingReportId": {
                    "summary": "reportId is missing from the request body, e.g. {}",
                    "value": {
                      "status": "error",
                      "error": "reportId is required"
                    }
                  },
                  "emptyReportId": {
                    "summary": "reportId is an empty string, e.g. { \"reportId\": \"\" }",
                    "value": {
                      "status": "error",
                      "error": "reportId is required"
                    }
                  },
                  "reportIdNotAString": {
                    "summary": "reportId is not a string, e.g. { \"reportId\": 123 }",
                    "value": {
                      "status": "error",
                      "error": "reportId is required"
                    }
                  },
                  "invalidReportId": {
                    "summary": "reportId is not a valid report id, e.g. { \"reportId\": \"abc\" }",
                    "value": {
                      "status": "error",
                      "error": "reportId must be a valid report id"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "A missing/invalid x-api-key, an account without the Client Reports entitlement, or a report the caller can't access. The x-api-key case has a different response shape - see examples.",
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/ErrorResponse"
                    },
                    {
                      "$ref": "#/components/schemas/ApiGatewayForbiddenResponse"
                    }
                  ]
                },
                "examples": {
                  "accessDenied": {
                    "summary": "The report isn't one the caller may access",
                    "value": {
                      "status": "error",
                      "error": "Access denied to this reportId"
                    }
                  },
                  "noReportsEntitlement": {
                    "summary": "The account doesn't have access to reports",
                    "value": {
                      "status": "error",
                      "error": "Unauthorized: account does not have permission to access this endpoint"
                    }
                  },
                  "invalidApiKey": {
                    "summary": "Missing or invalid x-api-key",
                    "value": {
                      "message": "Forbidden"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Report not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "reportNotFound": {
                    "summary": "No report with this reportId",
                    "value": {
                      "status": "error",
                      "error": "Report not found"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      },
      "get": {
        "tags": [
          "client-report"
        ],
        "summary": "Get the status of a Client Report PDF generation request",
        "description": "Get the status of a PDF requested with POST /clientReports/generatePDF. Keep polling while `status` is \"started\" or \"inProgress\"; once it is \"done\" the response includes the download link.",
        "operationId": "getClientReportStatus",
        "parameters": [
          {
            "name": "jobId",
            "in": "query",
            "description": "The job ID returned by /clientReports/generatePDF",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientReportStatus"
                },
                "examples": {
                  "done": {
                    "summary": "The PDF is ready",
                    "value": {
                      "reportId": "6aa7e575bae1c11111b1fc11",
                      "jobId": "6a7f0c1e2b3d4e5f60123456",
                      "status": "done",
                      "downloadUrl": "https://marketplace-manager-presignedbucket-<env>.amazonaws.com/...",
                      "downloadUrlExpiresAt": "2026-10-23T04:00:10.000Z",
                      "generatedAt": "2026-10-23T00:00:10.000Z"
                    }
                  },
                  "inProgress": {
                    "summary": "Still generating - check again shortly",
                    "value": {
                      "reportId": "6aa7e575bae1c11111b1fc11",
                      "jobId": "6a7f0c1e2b3d4e5f60123456",
                      "status": "inProgress"
                    }
                  },
                  "reportNotAvailable": {
                    "summary": "Errored - the report could not be displayed",
                    "value": {
                      "reportId": "6aa7e575bae1c11111b1fc11",
                      "jobId": "6a7f0c1e2b3d4e5f60123456",
                      "status": "errored",
                      "errorReason": "The report could not be displayed - it may have been deleted or is not available"
                    }
                  },
                  "timedOut": {
                    "summary": "Errored - the report took too long to render",
                    "value": {
                      "reportId": "6aa7e575bae1c11111b1fc11",
                      "jobId": "6a7f0c1e2b3d4e5f60123456",
                      "status": "errored",
                      "errorReason": "The report took too long to render - please try again"
                    }
                  },
                  "interrupted": {
                    "summary": "Errored - generation was interrupted",
                    "value": {
                      "reportId": "6aa7e575bae1c11111b1fc11",
                      "jobId": "6a7f0c1e2b3d4e5f60123456",
                      "status": "errored",
                      "errorReason": "PDF generation was interrupted - please try again"
                    }
                  },
                  "notStarted": {
                    "summary": "Errored - generation could not be started",
                    "value": {
                      "reportId": "6aa7e575bae1c11111b1fc11",
                      "jobId": "6a7f0c1e2b3d4e5f60123456",
                      "status": "errored",
                      "errorReason": "PDF generation could not be started - please try again"
                    }
                  },
                  "failed": {
                    "summary": "Errored - any other failure",
                    "value": {
                      "reportId": "6aa7e575bae1c11111b1fc11",
                      "jobId": "6a7f0c1e2b3d4e5f60123456",
                      "status": "errored",
                      "errorReason": "PDF generation failed - please try again"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "missingJobId": {
                    "summary": "jobId query parameter is missing, e.g. /clientReports/generatePDF",
                    "value": {
                      "status": "error",
                      "error": "jobId is required"
                    }
                  },
                  "emptyJobId": {
                    "summary": "jobId query parameter is empty, e.g. ?jobId=",
                    "value": {
                      "status": "error",
                      "error": "jobId is required"
                    }
                  },
                  "invalidJobId": {
                    "summary": "jobId is not a valid job id, e.g. ?jobId=abc",
                    "value": {
                      "status": "error",
                      "error": "jobId must be a valid job id"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Missing or invalid x-api-key",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiGatewayForbiddenResponse"
                },
                "examples": {
                  "invalidApiKey": {
                    "summary": "Missing or invalid x-api-key",
                    "value": {
                      "message": "Forbidden"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "jobNotFound": {
                    "summary": "No job exists with the given jobId",
                    "value": {
                      "status": "error",
                      "error": "No report download job with jobId 6a7f0c1e2b3d4e5f88819999"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/trafficAndConversion": {
      "post": {
        "tags": ["report"],
        "summary": "Create a traffic and conversion report",
        "description": "Create a \"traffic and conversion\" report. The generated report CSV contains the columns defined in the `TrafficAndConversionReportColumns` schema. When the 'view' option is set to 'skus', additional columns 'sku' and 'brand' are included. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createTrafficAndConversionReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateTrafficAndConversionReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/TrafficAndConversionReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/cancellationsAndRefunds": {
      "post": {
        "tags": ["report"],
        "summary": "Create a cancellations and refunds report",
        "description": "Create a \"cancellations and refunds\" report. The generated report CSV contains the columns defined in the `CancellationsAndRefundsReportColumns` schema. Note that cancelledSales, cancelRate, and their prior period equivalents are hidden for Amazon seller channels. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createCancellationsAndRefundsReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCancellationsAndRefundsReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/CancellationsAndRefundsReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/customerLifetimeValue": {
      "post": {
        "tags": ["report"],
        "summary": "Create a customer lifetime value report",
        "description": "Create a \"customer lifetime value\" report. The generated report CSV contains the columns defined in the `CustomerLifetimeValueReportColumns` schema including cohort metrics such as LTV, CAC, and repeat purchase frequency. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createCustomerLifetimeValueReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCustomerLifetimeValueReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerLifetimeValueReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/shippedRevenue": {
      "post": {
        "tags": ["report"],
        "summary": "Create a shipped revenue report",
        "description": "Create a \"shipped revenue\" report (Amazon Vendor). The generated report CSV contains the columns defined in the `ShippedRevenueReportColumns` schema. The 'view' option selects between 'sourcing' and 'manufacturing' data. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createShippedRevenueReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateShippedRevenueReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/ShippedRevenueReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/orderedRevenue": {
      "post": {
        "tags": ["report"],
        "summary": "Create an ordered revenue report",
        "description": "Create an \"ordered revenue\" report (Amazon Vendor). The generated report CSV contains the columns defined in the `OrderedRevenueReportColumns` schema. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createOrderedRevenueReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateOrderedRevenueReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/OrderedRevenueReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/inventoryHealth": {
      "post": {
        "tags": ["report"],
        "summary": "Create an inventory health report",
        "description": "Create an \"inventory health\" report (Amazon Vendor). The generated report CSV contains the columns defined in the `InventoryHealthReportColumns` schema including sellable, unhealthy, aged, and unsellable inventory metrics. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createInventoryHealthReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateInventoryHealthReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryHealthReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/campaigns": {
      "post": {
        "tags": ["report"],
        "summary": "Create a campaigns report",
        "description": "Create a \"campaigns\" report (Amazon Advertising). The download contains multiple CSV files: campaigns, ad groups, keywords, product ads, and products. See the `CampaignsReportCampaignColumns`, `CampaignsReportAdGroupColumns`, `CampaignsReportKeywordColumns`, `CampaignsReportProductAdColumns`, and `CampaignsReportProductColumns` schemas for the columns in each file. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createCampaignsReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCampaignsReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/CampaignsReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/inventoryReplenishment": {
      "post": {
        "tags": ["report"],
        "summary": "Create an inventory replenishment report",
        "description": "Create an \"inventory replenishment\" report (Amazon FBA). The generated report CSV contains the columns defined in the `InventoryReplenishmentReportColumns` schema including days cover, projected OOS dates, and replenishment recommendations. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createInventoryReplenishmentReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateInventoryReplenishmentReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/InventoryReplenishmentReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/channelProfitAndLoss": {
      "post": {
        "tags": ["report"],
        "summary": "Create a channel profit and loss report",
        "description": "Create a \"channel profit and loss\" report. The generated report CSV contains the columns defined in the `ChannelProfitAndLossReportColumns` schema including revenue, fees, COGS, advertising, and profit breakdown by store. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createChannelProfitAndLossReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateChannelProfitAndLossReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/ChannelProfitAndLossReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/amazonBuyBoxPerformance": {
      "post": {
        "tags": ["report"],
        "summary": "Create an Amazon Buy Box Performance report",
        "description": "Create an Amazon Buy Box Performance report. The generated report CSV contains the columns defined in the `AmazonBuyBoxPerformanceReportColumns` schema including your price, competitive price, and detailed offer attributes. An additional 'offerPoints' column is included for Japanese marketplaces. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createAmazonBuyBoxPerformanceReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateAmazonBuyBoxPerformanceReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/AmazonBuyBoxPerformanceReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/repeatPurchase": {
      "post": {
        "tags": ["report"],
        "summary": "Create a repeat purchase report",
        "description": "Create a \"repeat purchase\" report. The generated report CSV contains the columns defined in the `RepeatPurchaseReportColumns` schema including repeat customer counts, sales percentages, and per-customer revenue metrics. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createRepeatPurchaseReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateRepeatPurchaseReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/RepeatPurchaseReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/suppressedProduct": {
      "post": {
        "tags": ["report"],
        "summary": "Create a suppressed product report",
        "description": "Create a \"suppressed product\" report. The generated report CSV contains the columns defined in the `SuppressedProductReportColumns` schema including suppression dates, issue types, estimated lost sales, and fix URLs. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createSuppressedProductReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateSuppressedProductReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/SuppressedProductReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/marketingByProduct": {
      "post": {
        "tags": ["report"],
        "summary": "Create a marketing by product report",
        "description": "Create a \"marketing by product\" report. The generated report CSV contains the columns defined in the `MarketingByProductReportColumns` schema including ad sales, spend, ACOS, ROAS, TACOS, and new-to-brand metrics by store. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createMarketingByProductReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateMarketingByProductReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/MarketingByProductReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/subscribeAndSave": {
      "post": {
        "tags": ["report"],
        "summary": "Create a subscribe and save report",
        "description": "Create a \"subscribe and save\" report (Amazon). The generated report CSV contains the columns defined in the `SubscribeAndSaveReportColumns` schema including subscriber counts, shipped revenue, revenue penetration, and discount tiers. Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createSubscribeAndSaveReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateSubscribeAndSaveReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/SubscribeAndSaveReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/create/products": {
      "post": {
        "tags": ["report"],
        "summary": "Create a products report (Requires Enterprise plan)",
        "description": "Create a \"products\" report (Amazon). The generated report CSV contains the columns defined in the `ProductsReportColumns` schema including pricing, inventory, COGS, fees, and category information. \n\n**NOTE: This endpoint is only available to users on the Enterprise plan.** Use the /reports/status/{reportId} endpoint to check report status and obtain the download URL.",
        "operationId": "createProductsReport",
        "requestBody": {
          "description": "Report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateProductsReportRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateReportResponse"
                }
              },
              "text/csv": {
                "schema": {
                  "$ref": "#/components/schemas/ProductsReportColumns"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/status/{reportId}": {
      "get": {
        "tags": ["report"],
        "summary": "Get the status of a report request",
        "description": "Get the status of a report request",
        "operationId": "getReportStatus",
        "parameters": [
          {
            "name": "reportId",
            "in": "path",
            "description": "Report ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportStatus"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          },
          "404": {
            "description": "Not found",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/view/vendorSalesByPeriod": {
      "post": {
        "tags": ["report"],
        "summary": "Retrieve vendor sales-by-period performance",
        "description": "Retrieve aggregated revenue with advertising metrics for a merchant over the selected date range, grouped by the requested interval.",
        "operationId": "getVendorSalesByPeriodReport",
        "requestBody": {
          "description": "Report filters that identify the merchant, time range, and marketplace scope to evaluate.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VendorSalesByPeriodRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Aggregated performance data grouped to match the requested interval.",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VendorSalesByPeriodSuccessResponse"
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VendorSalesByPeriodErrorResponse"
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VendorSalesByPeriodErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/view/salesByPeriod": {
      "post": {
        "tags": ["report"],
        "summary": "Retrieve sales-by-period performance",
        "description": "Retrieve aggregated GMV, traffic, and advertising metrics for a merchant over the selected date range, grouped by the requested interval.",
        "operationId": "getSalesByPeriodReport",
        "requestBody": {
          "description": "Report filters that identify the merchant, time range, and marketplace scope to evaluate.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SalesByPeriodRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Aggregated performance data grouped to match the requested interval.",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalesByPeriodSuccessResponse"
                }
              }
            }
          },
          "400": {
            "description": "Missing or invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalesByPeriodErrorResponse"
                }
              }
            }
          },
          "default": {
            "description": "Unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalesByPeriodErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/view/advertisingByChannels": {
      "post": {
        "tags": ["report"],
        "summary": "Retrieve advertising performance by channel",
        "description": "Retrieve a paginated JSON summary of advertising performance grouped by channel for the selected store and date range. Values are currency-adjusted based on the store's country and the provided currency context.",
        "operationId": "getAdvertisingByChannels",
        "requestBody": {
          "description": "Advertising by channels criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetAdvertisingByChannelsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAdvertisingByChannelsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/view/salesByChannel": {
      "post": {
        "tags": ["report"],
        "summary": "Retrieve sales performance by channel",
        "description": "Retrieve sales performance broken down by store/channel for the selected filters and date range, with prior-period comparison.",
        "operationId": "viewSalesByChannelReport",
        "requestBody": {
          "description": "Sales by channel report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ViewSalesByChannelRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SalesByChannelResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/reports/view/salesByProduct": {
      "post": {
        "tags": ["report"],
        "summary": "Retrieve sales performance by product",
        "description": "Retrieve sales performance broken down by product for the selected channel and date range, with prior-period comparison.",
        "operationId": "viewSalesByProductReport",
        "requestBody": {
          "description": "Sales by product report criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ViewSalesByProductRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ViewSalesByProductResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/profitability/storeProfitAndLoss": {
      "post": {
        "tags": ["profitability"],
        "summary": "Get a store profit and loss",
        "description": "Get a \"store profit and loss\"",
        "operationId": "getStoreProfitAndLoss",
        "requestBody": {
          "description": "Store profit and loss criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetStoreProfitAndLossRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetStoreProfitAndLossResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "missingParam": {
                    "summary": "A required reportOptions field is missing",
                    "value": { "status": "error", "error": "Missing or invalid parameters: reportOptions.fromDate, reportOptions.toDate" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "Invalid channelId / merchantId" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/profitability/productProfitAndLoss": {
      "post": {
        "tags": ["profitability"],
        "summary": "Retrieve single or multiple product profit and loss details",
        "description": "Retrieve single or multiple product profit and loss details",
        "operationId": "getProductProfitAndLoss",
        "requestBody": {
          "description": "Product profit and loss criteria",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetProductProfitAndLossRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetProductProfitAndLossResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "tooManySellerSkus": {
                    "summary": "More than 50 sellerSkus passed in reportOptions",
                    "value": { "status": "error", "error": "The maximum number of sellerSkus that can be passed in at a time is 50" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "Invalid channelId / merchantId" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/profitability/directCosts": {
      "post": {
        "tags": ["profitability"],
        "summary": "Update Unit COGS",
        "description": "Update Unit COGS",
        "operationId": "updateDirectCosts",
        "requestBody": {
          "description": "Input required to update Unit COGS",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateDirectCostsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateDirectCostsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "unsupportedMarketplace": {
                    "summary": "Channel's marketplace does not support direct costs yet",
                    "value": { "status": "error", "error": "The marketplace type is not supported at the moment" }
                  },
                  "invalidCogs": {
                    "summary": "cogs is missing, non-numeric, or the currency code is invalid for a SKU",
                    "value": { "status": "error", "error": "Invalid cogs for SKU: ABC-123" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/profitability/directCostsJobStatus": {
      "get": {
        "tags": ["profitability"],
        "summary": "Get the status of a Unit COGS update job",
        "description": "Get the status of a Unit COGS update job",
        "operationId": "getDirectCostsJobStatus",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "jobId",
            "in": "query",
            "description": "Job ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DirectCostJobStatus"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "missingParam": {
                    "summary": "A required query parameter is missing",
                    "value": { "status": "error", "error": "Missing or invalid parameters: jobId" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "invalid channelId / merchantId" }
                  },
                  "unsupportedMarketplace": {
                    "summary": "Channel's marketplace does not support direct costs yet",
                    "value": { "status": "error", "error": "The marketplace type is not supported at the moment" }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {}
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/customGroups": {
      "get": {
        "tags": ["custom-group"],
        "summary": "Retrieve custom groups for a channel",
        "description": "Retrieve the list of custom product groups defined for a given channel.",
        "operationId": "getCustomGroups",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of groups per page, max 100 (default 10).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 10
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetCustomGroupsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "missingChannelId": {
                    "summary": "channelId is missing",
                    "value": { "status": "error", "error": "channelId is required" }
                  },
                  "invalidPageSize": {
                    "summary": "pageSize is not a positive integer",
                    "value": { "status": "error", "error": "pageSize must be a positive integer" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "Invalid channelId / merchantId" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      },
      "post": {
        "tags": ["custom-group"],
        "summary": "Create a custom group",
        "description": "Create a new custom product group for a channel.",
        "operationId": "createCustomGroup",
        "requestBody": {
          "description": "Custom group details",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateCustomGroupRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateCustomGroupResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "missingGroupName": {
                    "summary": "groupName is missing",
                    "value": { "status": "error", "error": "groupName is required" }
                  },
                  "bothProductsAndBrands": {
                    "summary": "Both products and brands were provided",
                    "value": { "status": "error", "error": "Only one of products or brands can be provided, not both" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "Invalid channelId / merchantId" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/customGroups/{id}": {
      "get": {
        "tags": ["custom-group"],
        "summary": "Retrieve a single custom group",
        "description": "Retrieve a single custom group with its associated products and brands.",
        "operationId": "getCustomGroup",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Group ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetCustomGroupResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "invalidGroupId": {
                    "summary": "id is not a valid numeric group id",
                    "value": { "status": "error", "error": "groupId must be a valid numeric id" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "Invalid channelId / merchantId" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      },
      "patch": {
        "tags": ["custom-group"],
        "summary": "Update a custom group",
        "description": "Add or remove products/brands and optionally rename the group. Provide at least one of addProducts, removeProducts, addBrands, removeBrands, or groupName. Cannot mix product and brand operations in the same request.",
        "operationId": "editCustomGroup",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Group ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PatchGroupRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {}
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "noFieldsProvided": {
                    "summary": "None of groupName/addProducts/removeProducts/addBrands/removeBrands provided",
                    "value": { "status": "error", "error": "At least one of groupName, addProducts, removeProducts, addBrands, removeBrands must be provided" }
                  },
                  "mixedProductsAndBrands": {
                    "summary": "Both product and brand operations provided in the same request",
                    "value": { "status": "error", "error": "Cannot mix product and brand operations in the same request" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "Invalid channelId / merchantId" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      },
      "delete": {
        "tags": ["custom-group"],
        "summary": "Delete a custom group",
        "description": "Delete a custom product group for a channel.",
        "operationId": "deleteCustomGroup",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Group ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {}
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "invalidGroupId": {
                    "summary": "id is not a valid numeric group id",
                    "value": { "status": "error", "error": "groupId must be a valid numeric id" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "Invalid channelId / merchantId" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/tags": {
      "get": {
        "tags": ["tag"],
        "summary": "Retrieve all tags",
        "description": "Retrieve a paginated list of tags across all of the caller's channels. Each item is one channel with its tags. Shared tags are prefixed with 'org://'. Pagination uses pageIndex/pageSize (zero-based); pageSize defaults to 25 and is capped at 100, pageIndex defaults to 0.",
        "operationId": "getAllTags",
        "parameters": [
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of channels per page (default 25, max 100)",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 25
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0)",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAllTagsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "invalidPageSize": {
                    "summary": "pageSize is not a positive integer",
                    "value": { "status": "error", "error": "pageSize must be a positive integer" }
                  },
                  "invalidPageIndex": {
                    "summary": "pageIndex is not a non-negative integer",
                    "value": { "status": "error", "error": "pageIndex must be a non-negative integer" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/tags/channel": {
      "get": {
        "tags": ["tag"],
        "summary": "Retrieve tags from a specific channel",
        "description": "Retrieve the tags for a single channel, identified by channelId and merchantId. Shared tags are prefixed with 'org://'. A channel with no tags returns an empty tags array.",
        "operationId": "getChannelTags",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel (store) ID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID of the channel (URL-encode values containing spaces or '@')",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicChannelTags"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "missingChannelId": {
                    "summary": "channelId is missing",
                    "value": { "status": "error", "error": "channelId is required" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "invalid channelId / merchantId" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      },
      "patch": {
        "tags": ["tag"],
        "summary": "Add and/or remove tags on a specific channel",
        "description": "Partially update the tags on a single channel, identified by channelId and merchantId, by supplying addTags and/or removeTags. At least one of the two must be provided, and a tag cannot appear in both lists. A maximum of 5 tags can be added in a single call. Shared tags are prefixed with 'org://'. Returns the channel's full tag set after the change.",
        "operationId": "updateChannelTags",
        "requestBody": {
          "description": "Channel identifiers and the tags to add and/or remove (at least one of addTags / removeTags)",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdateChannelTagsRequest"
              },
              "example": {
                "channelId": "A1234567890ABC",
                "merchantId": "XXXUS @ ATVPDKIKX0DER",
                "addTags": ["north-america"],
                "removeTags": ["org://ebay"]
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicChannelTags"
                },
                "example": {
                  "channelId": "A1234567890ABC",
                  "merchantId": "XXXUS @ ATVPDKIKX0DER",
                  "tags": ["amazon", "north-america"]
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "noTagsProvided": {
                    "summary": "Neither addTags nor removeTags was provided",
                    "value": { "status": "error", "error": "At least one of addTags or removeTags must be provided" }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": { "status": "error", "error": "invalid channelId / merchantId" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/tags/convert": {
      "post": {
        "tags": ["tag"],
        "summary": "Convert a tag between private and shared",
        "description": "Toggle a single tag (private/shared) across every channel that carries it. Shared tags are prefixed with 'org://'; converting a private tag makes it 'org://&lt;tag&gt;' and vice versa. Only one tag can be converted per request. Returns the full tag set after the conversion.",
        "operationId": "convertTags",
        "requestBody": {
          "description": "The tag to convert (exactly 1)",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ConvertTagsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConvertTagsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" },
                "examples": {
                  "missingTag": {
                    "summary": "tag is missing or empty",
                    "value": { "status": "error", "error": "Tag must be a non-empty string" }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/advertising/campaigns": {
      "get": {
        "tags": ["advertising"],
        "summary": "Retrieve multi-channel advertising campaign performance",
        "description": "Returns paginated advertising campaign performance across up to 5 channels for the selected date range. Values are currency-adjusted based on each store's country and the requested currency. Supports filtering by campaign status and custom campaign groups, sorting by any response column, and zero-based page indexing.",
        "operationId": "getAdvertisingCampaigns",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel ID. Repeat the parameter for multiple channels (max 5).",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Start of date range as unix epoch seconds. Defaults to 30 days ago.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "End of date range as unix epoch seconds. Defaults to now. The range must not exceed 6 months.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "3-letter ISO currency code (default USD).",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter by campaign status bucket. Repeatable.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": ["active", "paused", "archived"]
              }
            }
          },
          {
            "name": "customCampaignGroupId",
            "in": "query",
            "description": "Filter to campaigns in the given custom campaign group(s). Repeatable (max 10). Groups must belong to the caller and relate to the requested channels.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "sortKey",
            "in": "query",
            "description": "Response column to sort by (default campaign_name).",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["channel_id", "campaign_id", "ad_type", "campaign_name", "campaign_status", "budget", "budget_type", "start_date", "end_date", "targeting_type", "bidding_strategy", "cost_type", "impressions", "clicks", "cost", "attributed_sales", "attributed_sales_same_sku", "attributed_conversions", "attributed_conversions_same_sku", "attributed_units_ordered", "attributed_units_ordered_same_sku", "attributed_orders_ntb", "attributed_units_ordered_ntb", "attributed_sales_ntb", "attributed_orders_ntb_percentage", "attributed_units_ordered_ntb_percentage", "attributed_sales_ntb_percentage", "attributed_detail_page_views_clicks", "acos", "click_through_rate", "cost_per_click", "cost_per_acquisition", "conversion_rate", "roas"],
              "default": "campaign_name"
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort direction (default desc).",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["asc", "desc"]
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of campaigns per page, max 100 (default 10).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAdvertisingCampaignsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "tooManyChannelIds": {
                    "summary": "More than 5 channelId values supplied",
                    "value": {
                      "status": "error",
                      "error": "a maximum of 5 channelId values is allowed"
                    }
                  },
                  "noAdvertisingConnection": {
                    "summary": "Channel is valid but has no advertising connection",
                    "value": {
                      "status": "error",
                      "error": "The channelId of 4 do not have an advertising connection"
                    }
                  },
                  "dateRangeTooLong": {
                    "summary": "Window exceeds the 6-month maximum",
                    "value": {
                      "status": "error",
                      "error": "Date range must not exceed 6 months"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/advertising/adGroups": {
      "get": {
        "tags": ["advertising"],
        "summary": "Retrieve multi-channel advertising ad group performance",
        "description": "Returns paginated advertising ad group performance across up to 5 channels for the selected date range, optionally filtered to specific campaigns. Values are currency-adjusted based on each store's country and the requested currency. Supports filtering by ad group status, sorting by any response column, and zero-based page indexing.",
        "operationId": "getAdvertisingAdGroups",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel ID. Repeat the parameter for multiple channels (max 5).",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "campaignId",
            "in": "query",
            "description": "Filter to ad groups belonging to the given campaign(s). Repeatable (max 10), numeric.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Start of date range as unix epoch seconds. Defaults to 30 days ago.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "End of date range as unix epoch seconds. Defaults to now. The range must not exceed 6 months.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "3-letter ISO currency code (default USD).",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter by ad group status bucket. Repeatable.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": ["active", "paused", "archived"]
              }
            }
          },
          {
            "name": "sortKey",
            "in": "query",
            "description": "Response column to sort by (default ad_group_name).",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["channel_id", "campaign_id", "ad_group_id", "ad_type", "campaign_name", "ad_group_name", "ad_group_status", "default_bid", "cost_type", "impressions", "clicks", "cost", "attributed_sales", "attributed_sales_same_sku", "attributed_conversions", "attributed_conversions_same_sku", "attributed_units_ordered", "attributed_units_ordered_same_sku", "attributed_orders_ntb", "attributed_units_ordered_ntb", "attributed_sales_ntb", "attributed_orders_ntb_percentage", "attributed_units_ordered_ntb_percentage", "attributed_sales_ntb_percentage", "attributed_detail_page_views_clicks", "acos", "click_through_rate", "cost_per_click", "conversion_rate", "roas"],
              "default": "ad_group_name"
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort direction (default desc).",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["asc", "desc"]
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of ad groups per page, max 100 (default 10).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAdvertisingAdGroupsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "tooManyCampaignIds": {
                    "summary": "More than 10 campaignId values supplied",
                    "value": {
                      "status": "error",
                      "error": "a maximum of 10 campaignId values is allowed"
                    }
                  },
                  "campaignIdNotNumeric": {
                    "summary": "campaignId must be digits only",
                    "value": {
                      "status": "error",
                      "error": "campaignId must be numeric"
                    }
                  },
                  "channelNotAccessible": {
                    "summary": "channelId unknown or not visible to this API key",
                    "value": {
                      "status": "error",
                      "error": "The channelId of 888423 are invalid or not accessible"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/advertising/keywords": {
      "get": {
        "tags": ["advertising"],
        "summary": "Retrieve multi-channel advertising keyword performance",
        "description": "Returns paginated advertising keyword performance across up to 5 channels for the selected date range, optionally filtered to specific campaigns and ad groups. Values are currency-adjusted based on each store's country and the requested currency. Supports filtering by keyword status, sorting by any response column, and zero-based page indexing.",
        "operationId": "getAdvertisingKeywords",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel ID. Repeat the parameter for multiple channels (max 5).",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "campaignId",
            "in": "query",
            "description": "Filter to keywords belonging to the given campaign(s). Repeatable (max 10), numeric.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "adGroupId",
            "in": "query",
            "description": "Filter to keywords belonging to the given ad group(s). Repeatable (max 10), numeric.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Start of date range as unix epoch seconds. Defaults to 30 days ago.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "End of date range as unix epoch seconds. Defaults to now. The range must not exceed 6 months.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "3-letter ISO currency code (default USD).",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Filter by keyword status bucket. Repeatable.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": ["active", "paused", "archived"]
              }
            }
          },
          {
            "name": "sortKey",
            "in": "query",
            "description": "Response column to sort by (default keyword_text).",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["channel_id", "campaign_id", "ad_group_id", "keyword_id", "ad_type", "campaign_name", "ad_group_name", "keyword_text", "match_type", "keyword_status", "bid", "cost_type", "impressions", "clicks", "cost", "attributed_sales", "attributed_sales_same_sku", "attributed_conversions", "attributed_conversions_same_sku", "attributed_units_ordered", "attributed_units_ordered_same_sku", "attributed_orders_ntb", "attributed_units_ordered_ntb", "attributed_sales_ntb", "attributed_detail_page_views_clicks", "attributed_orders_ntb_percentage", "attributed_units_ordered_ntb_percentage", "attributed_sales_ntb_percentage", "acos", "click_through_rate", "cost_per_click", "conversion_rate", "cost_per_acquisition", "roas"],
              "default": "keyword_text"
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort direction (default desc).",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["asc", "desc"]
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of keywords per page, max 100 (default 10).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAdvertisingKeywordsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "tooManyAdGroupIds": {
                    "summary": "More than 10 adGroupId values supplied",
                    "value": {
                      "status": "error",
                      "error": "a maximum of 10 adGroupId values is allowed"
                    }
                  },
                  "invalidStatus": {
                    "summary": "status outside the supported buckets",
                    "value": {
                      "status": "error",
                      "error": "Status must be one of: active, paused, archived"
                    }
                  },
                  "pageSizeTooLarge": {
                    "summary": "pageSize above the 100 maximum",
                    "value": {
                      "status": "error",
                      "error": "pageSize must not exceed 100"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/advertising/products": {
      "get": {
        "tags": ["advertising"],
        "summary": "Retrieve multi-channel advertising product performance",
        "description": "Returns paginated advertising product (ASIN) performance across up to 5 channels for the selected date range, optionally filtered to specific products. Values are currency-adjusted based on each store's country and the requested currency. Supports sorting by any response column and zero-based page indexing.",
        "operationId": "getAdvertisingProducts",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel ID. Repeat the parameter for multiple channels (max 5).",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "productSku",
            "in": "query",
            "description": "Filter to the given product(s) by their normalised product identifier — an ASIN on Amazon, or the equivalent product identifier the channel's platform uses. Repeatable (max 10).",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Start of date range as unix epoch seconds. Defaults to 30 days ago.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "End of date range as unix epoch seconds. Defaults to now. The range must not exceed 6 months.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "3-letter ISO currency code (default USD).",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sortKey",
            "in": "query",
            "description": "Response column to sort by (default product_sku).",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["channel_id", "product_sku", "impressions", "clicks", "cost", "attributed_sales", "attributed_sales_same_sku", "attributed_conversions", "attributed_conversions_same_sku", "attributed_units_ordered", "attributed_units_ordered_same_sku", "acos", "click_through_rate", "cost_per_click", "conversion_rate", "roas"],
              "default": "product_sku"
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort direction (default desc).",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["asc", "desc"]
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of products per page, max 100 (default 10).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAdvertisingProductsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "tooManyProductSkus": {
                    "summary": "More than 10 productSku values supplied",
                    "value": {
                      "status": "error",
                      "error": "a maximum of 10 productSku values is allowed"
                    }
                  },
                  "tooManyChannelIds": {
                    "summary": "More than 5 channelId values supplied",
                    "value": {
                      "status": "error",
                      "error": "a maximum of 5 channelId values is allowed"
                    }
                  },
                  "dateRangeTooLong": {
                    "summary": "Window exceeds the 6-month maximum",
                    "value": {
                      "status": "error",
                      "error": "Date range must not exceed 6 months"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/advertising/searchTerms": {
      "get": {
        "tags": ["advertising"],
        "summary": "Retrieve advertising search term performance",
        "description": "Returns paginated advertising search term performance for a single channel for the selected date range, optionally filtered to specific campaigns, ad groups, keywords, match types or a search term. Metrics are aggregated across every keyword sharing the same search term (within the same ad type), so campaignId/adGroupId/keywordId/matchType act only as filters - the response does not include keyword/campaign-level fields. Values are currency-adjusted based on the store's country and the requested currency. Supports sorting by any response column and zero-based page indexing.",
        "operationId": "getAdvertisingSearchTerms",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel ID. Only a single channel is supported for this endpoint.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "campaignId",
            "in": "query",
            "description": "Filter to search terms belonging to the given campaign(s). Repeatable (max 10), numeric.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "adGroupId",
            "in": "query",
            "description": "Filter to search terms belonging to the given ad group(s). Repeatable (max 10), numeric.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "keywordId",
            "in": "query",
            "description": "Filter to search terms belonging to the given keyword(s). Repeatable (max 10), numeric.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "matchType",
            "in": "query",
            "description": "Filter to search terms matched via the given keyword match type(s). Repeatable, case-insensitive.",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": ["BROAD", "EXACT", "PHRASE", "TARGETING_EXPRESSION", "TARGETING_EXPRESSION_PREDEFINED"]
              }
            }
          },
          {
            "name": "searchTerm",
            "in": "query",
            "description": "Case-insensitive substring filter on the customer search term.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fromDate",
            "in": "query",
            "description": "Start of date range as unix epoch seconds. Defaults to 30 days ago.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "toDate",
            "in": "query",
            "description": "End of date range as unix epoch seconds. Defaults to now. The range must not exceed 6 months.",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "3-letter ISO currency code (default USD).",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sortKey",
            "in": "query",
            "description": "Response column to sort by (default cost). Note: attributed_sales_same_sku, attributed_conversions_same_sku and attributed_units_ordered_same_sku are always 0 for ad_type SB, so sorting by one of them won't distinguish between SB rows.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["ad_type", "search_term", "impressions", "clicks", "cost", "attributed_sales", "attributed_sales_same_sku", "attributed_conversions", "attributed_conversions_same_sku", "attributed_units_ordered", "attributed_units_ordered_same_sku", "acos", "click_through_rate", "cost_per_click", "conversion_rate", "cost_per_acquisition", "roas"],
              "default": "cost"
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Sort direction (default desc).",
            "required": false,
            "schema": {
              "type": "string",
              "enum": ["asc", "desc"]
            }
          },
          {
            "name": "pageIndex",
            "in": "query",
            "description": "Zero-based page index (default 0).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of (aggregated) search term rows per page, max 100 (default 10).",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetAdvertisingSearchTermsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "tooManyKeywordIds": {
                    "summary": "More than 10 keywordId values supplied",
                    "value": {
                      "status": "error",
                      "error": "a maximum of 10 keywordId values is allowed"
                    }
                  },
                  "invalidMatchType": {
                    "summary": "matchType outside the supported values",
                    "value": {
                      "status": "error",
                      "error": "matchType must be one of: BROAD, EXACT, PHRASE, TARGETING_EXPRESSION, TARGETING_EXPRESSION_PREDEFINED"
                    }
                  },
                  "dateRangeTooLarge": {
                    "summary": "Date range wider than 6 months",
                    "value": {
                      "status": "error",
                      "error": "Date range must not exceed 6 months"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/sellerHealth": {
      "get": {
        "tags": [
          "seller-health"
        ],
        "summary": "Retrieve seller account health data for a channel",
        "description": "Returns the channel's account health metrics. Only applicable for Amazon, eBay, Mirakl, Bol, Mercado Libre, Iconic marketplaces; other marketplaces return 400. The `metrics` groups and keys differ based on different marketplaces.",
        "operationId": "getSellerHealth",
        "parameters": [
          {
            "name": "channelId",
            "in": "query",
            "description": "Channel (store) ID.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "merchantId",
            "in": "query",
            "description": "Merchant ID that owns the channel. URL-encode values containing spaces or '@'.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "headers": {
              "Access-Control-Allow-Origin": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SellerHealthResponse"
                },
                "examples": {
                  "amazon": {
                    "summary": "Amazon",
                    "value": {
                      "channelId": "1",
                      "merchantId": "A1B2C3D4E5F6G7 @ ATVPDKIKX0DER",
                      "marketplace": "amazon",
                      "marketplaceSubtype": "amazon",
                      "countryCode": "USA",
                      "metrics": {
                        "accountHealth": {
                          "accountHealthRating": {
                            "value": 250,
                            "status": "GOOD",
                            "target": null,
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "inactiveListingsCount": {
                            "value": 0,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "listingIssuesCount": {
                            "value": 0,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "returnRequestsCount": {
                            "value": 0,
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          },
                          "suppressedListingsCount": {
                            "value": 0,
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          }
                        },
                        "shippingPerformance": {
                          "lateShipmentRate": {
                            "value": 0.012,
                            "status": "GOOD",
                            "target": {
                              "value": 0.04,
                              "condition": "LESS_THAN"
                            },
                            "window": {
                              "start": "2026-09-19T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            },
                            "numerator": 3,
                            "denominator": 250
                          },
                          "invoiceDefectRate": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0.05,
                              "condition": "LESS_THAN"
                            },
                            "window": {
                              "start": "2026-10-12T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            },
                            "numerator": 0,
                            "denominator": 120
                          },
                          "onTimeDeliveryRate": {
                            "value": 0.952,
                            "status": "GOOD",
                            "target": {
                              "value": 0.9,
                              "condition": "GREATER_THAN"
                            },
                            "window": {
                              "start": "2026-09-19T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            },
                            "numerator": 238,
                            "denominator": 250
                          },
                          "validTrackingRate": {
                            "value": 0.996,
                            "status": "GOOD",
                            "target": {
                              "value": 0.95,
                              "condition": "GREATER_THAN"
                            },
                            "window": {
                              "start": "2026-09-19T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            },
                            "numerator": 249,
                            "denominator": 250
                          },
                          "cancellationRate": {
                            "value": 0.015,
                            "status": "GOOD",
                            "target": {
                              "value": 0.025,
                              "condition": "LESS_THAN"
                            },
                            "window": {
                              "start": "2026-10-12T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            },
                            "numerator": 3,
                            "denominator": 200
                          }
                        },
                        "customerServiceFbm": {
                          "orderDefectRate": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0.01,
                              "condition": "LESS_THAN"
                            },
                            "window": {
                              "start": "2026-08-20T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            },
                            "numerator": 0,
                            "denominator": 400
                          },
                          "negativeFeedbackCount": {
                            "value": 0,
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          },
                          "chargebacksCount": {
                            "value": 0,
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          },
                          "azClaimsCount": {
                            "value": 0,
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          }
                        },
                        "customerServiceFba": {
                          "orderDefectRate": {
                            "value": 0.0025,
                            "status": "GOOD",
                            "target": {
                              "value": 0.01,
                              "condition": "LESS_THAN"
                            },
                            "window": {
                              "start": "2026-08-20T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            },
                            "numerator": 1,
                            "denominator": 400
                          },
                          "negativeFeedbackCount": {
                            "value": 1,
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          },
                          "chargebacksCount": {
                            "value": 0,
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          },
                          "azClaimsCount": {
                            "value": 0,
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          }
                        },
                        "policyCompliance": {
                          "ipComplaints": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0,
                              "condition": "EQUALS"
                            },
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "suspectedIpViolations": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0,
                              "condition": "EQUALS"
                            },
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "listingPolicyViolations": {
                            "value": 1,
                            "status": "POOR",
                            "target": {
                              "value": 0,
                              "condition": "EQUALS"
                            },
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "productAuthenticityComplaints": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0,
                              "condition": "EQUALS"
                            },
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "productSafetyComplaints": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0,
                              "condition": "EQUALS"
                            },
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "foodAndProductSafetyIssues": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0,
                              "condition": "EQUALS"
                            },
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "restrictedProductPolicyViolations": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0,
                              "condition": "EQUALS"
                            },
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "otherPolicyViolations": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0,
                              "condition": "EQUALS"
                            },
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "productConditionCustomerComplaints": {
                            "value": 2,
                            "status": "POOR",
                            "target": {
                              "value": 0,
                              "condition": "EQUALS"
                            },
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "productReviewPolicyViolations": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0,
                              "condition": "EQUALS"
                            },
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          },
                          "policyWarningsCount": {
                            "value": 3,
                            "status": null,
                            "target": null,
                            "window": {
                              "start": "2026-04-22T07:00:00Z",
                              "end": "2026-10-19T06:59:59Z"
                            }
                          }
                        }
                      }
                    }
                  },
                  "ebay": {
                    "summary": "eBay",
                    "value": {
                      "channelId": "2",
                      "merchantId": "examplestore",
                      "marketplace": "ebay",
                      "marketplaceSubtype": "ebay",
                      "countryCode": "USA",
                      "metrics": {
                        "accountHealth": {
                          "sellerLevel": {
                            "value": "TOP_RATED",
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          },
                          "projectedSellerLevel": {
                            "value": "ABOVE_STANDARD",
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          }
                        },
                        "shippingPerformance": {
                          "orderDefectRate": {
                            "value": 0.0042,
                            "status": "GOOD",
                            "target": null,
                            "window": {
                              "start": "2026-04-01T00:00:00.000Z",
                              "end": "2026-09-30T23:59:59.000Z"
                            },
                            "numerator": 3,
                            "denominator": 710
                          },
                          "lateShipmentRate": {
                            "value": 0.012,
                            "status": "GOOD",
                            "target": null,
                            "window": {
                              "start": "2026-04-01T00:00:00.000Z",
                              "end": "2026-09-30T23:59:59.000Z"
                            },
                            "numerator": 8,
                            "denominator": 660
                          },
                          "returnRequestsCount": {
                            "value": 1,
                            "status": "POOR",
                            "target": null,
                            "window": null
                          }
                        },
                        "resolutionCentre": {
                          "casesClosedWithoutResolutionRate": {
                            "value": 0.0014,
                            "status": "GOOD",
                            "target": null,
                            "window": {
                              "start": "2026-04-01T00:00:00.000Z",
                              "end": "2026-09-30T23:59:59.000Z"
                            },
                            "numerator": 1,
                            "denominator": 710
                          },
                          "casesCount": {
                            "value": 1,
                            "status": "POOR",
                            "target": null,
                            "window": null
                          },
                          "negativeFeedbackCount": {
                            "value": 2,
                            "status": "POOR",
                            "target": null,
                            "window": null
                          },
                          "newMessagesCount": {
                            "value": 5,
                            "status": null,
                            "target": null,
                            "window": null
                          }
                        }
                      }
                    }
                  },
                  "mirakl": {
                    "summary": "Mirakl",
                    "value": {
                      "channelId": "3",
                      "merchantId": "2001",
                      "marketplace": "mirakl",
                      "marketplaceSubtype": "bunnings",
                      "countryCode": "AUS",
                      "metrics": {
                        "accountHealth": {
                          "accountStatus": {
                            "value": "SUSPENDED",
                            "status": "AT_RISK",
                            "target": null,
                            "window": null
                          },
                          "accountGrade": {
                            "value": 3.8,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "approvalRate": {
                            "value": 0.85,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "messageThreadsCount": {
                            "value": 12,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "avgResponseTimeDays": {
                            "value": 0.08,
                            "status": "GOOD",
                            "target": null,
                            "window": null
                          }
                        }
                      }
                    }
                  },
                  "bol": {
                    "summary": "Bol",
                    "value": {
                      "channelId": "4",
                      "merchantId": "1234567",
                      "marketplace": "bol",
                      "marketplaceSubtype": "bol",
                      "countryCode": "NLD",
                      "metrics": {
                        "shippingPerformance": {
                          "onTimeDeliveryRate": {
                            "value": 0.985,
                            "status": "GOOD",
                            "target": {
                              "value": 0.97,
                              "condition": "GREATER_THAN_OR_EQUAL"
                            },
                            "window": {
                              "start": "2026-10-05T00:00:00.000Z",
                              "end": "2026-10-11T00:00:00.000Z"
                            },
                            "numerator": 197,
                            "denominator": 200
                          },
                          "validTrackingRate": {
                            "value": 0.9,
                            "status": "AT_RISK",
                            "target": {
                              "value": 1,
                              "condition": "GREATER_THAN_OR_EQUAL"
                            },
                            "window": {
                              "start": "2026-10-05T00:00:00.000Z",
                              "end": "2026-10-11T00:00:00.000Z"
                            },
                            "numerator": 180,
                            "denominator": 200
                          },
                          "cancellationRate": {
                            "value": 0.015,
                            "status": "GOOD",
                            "target": {
                              "value": 0.02,
                              "condition": "LESS_THAN_OR_EQUAL"
                            },
                            "window": {
                              "start": "2026-10-05T00:00:00.000Z",
                              "end": "2026-10-11T00:00:00.000Z"
                            },
                            "numerator": 3,
                            "denominator": 200
                          },
                          "returnRate": {
                            "value": 0.03,
                            "status": "GOOD",
                            "target": {
                              "value": 0.05,
                              "condition": "LESS_THAN_OR_EQUAL"
                            },
                            "window": {
                              "start": "2026-10-05T00:00:00.000Z",
                              "end": "2026-10-11T00:00:00.000Z"
                            },
                            "numerator": 6,
                            "denominator": 200
                          }
                        },
                        "customerService": {
                          "reviewScore": {
                            "value": 9.1,
                            "status": "GOOD",
                            "target": {
                              "value": 8,
                              "condition": "GREATER_THAN_OR_EQUAL"
                            },
                            "window": {
                              "start": "2026-10-05T00:00:00.000Z",
                              "end": "2026-10-11T00:00:00.000Z"
                            }
                          },
                          "phoneAvailabilityRate": {
                            "value": 0.95,
                            "status": "GOOD",
                            "target": {
                              "value": 0.9,
                              "condition": "GREATER_THAN_OR_EQUAL"
                            },
                            "window": {
                              "start": "2026-10-05T00:00:00.000Z",
                              "end": "2026-10-11T00:00:00.000Z"
                            },
                            "numerator": 19,
                            "denominator": 20
                          },
                          "supportCaseRate": {
                            "value": 0.02,
                            "status": "GOOD",
                            "target": {
                              "value": 0.05,
                              "condition": "LESS_THAN_OR_EQUAL"
                            },
                            "window": {
                              "start": "2026-10-05T00:00:00.000Z",
                              "end": "2026-10-11T00:00:00.000Z"
                            },
                            "numerator": 4,
                            "denominator": 200
                          },
                          "onTimeResponseRate": {
                            "value": 0.92,
                            "status": "GOOD",
                            "target": {
                              "value": 0.9,
                              "condition": "GREATER_THAN_OR_EQUAL"
                            },
                            "window": {
                              "start": "2026-10-05T00:00:00.000Z",
                              "end": "2026-10-11T00:00:00.000Z"
                            },
                            "numerator": 46,
                            "denominator": 50
                          }
                        }
                      }
                    }
                  },
                  "mercadolibre": {
                    "summary": "Mercado Libre",
                    "value": {
                      "channelId": "5",
                      "merchantId": "400000001",
                      "marketplace": "mercadolibre",
                      "marketplaceSubtype": "mercadolibre",
                      "countryCode": "MEX",
                      "metrics": {
                        "accountHealth": {
                          "powerSellerStatus": {
                            "value": "platinum",
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "realReputationLevel": {
                            "value": "red",
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "protectionEndDate": {
                            "value": "2026-11-01",
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "salesCount": {
                            "value": 242,
                            "status": null,
                            "target": null,
                            "window": {
                              "start": "2026-08-21T06:10:15.312Z",
                              "end": "2026-10-20T06:10:15.313Z"
                            }
                          }
                        },
                        "reputation": {
                          "claimsRate": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0.015,
                              "condition": "LESS_THAN"
                            },
                            "window": {
                              "start": "2026-08-21T06:10:15.313Z",
                              "end": "2026-10-20T06:10:15.313Z"
                            },
                            "numerator": 0,
                            "denominator": 242
                          },
                          "cancellationRate": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0.01,
                              "condition": "LESS_THAN"
                            },
                            "window": {
                              "start": "2026-08-21T06:10:15.313Z",
                              "end": "2026-10-20T06:10:15.313Z"
                            },
                            "numerator": 0,
                            "denominator": 242
                          },
                          "delayedHandlingRate": {
                            "value": 0,
                            "status": "GOOD",
                            "target": {
                              "value": 0.1,
                              "condition": "LESS_THAN"
                            },
                            "window": {
                              "start": "2026-08-21T06:10:15.313Z",
                              "end": "2026-10-20T06:10:15.313Z"
                            },
                            "numerator": 0,
                            "denominator": 242
                          }
                        },
                        "ratings": {
                          "negativeRate": {
                            "value": 0.02,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "neutralRate": {
                            "value": 0,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "positiveRate": {
                            "value": 0.98,
                            "status": null,
                            "target": null,
                            "window": null
                          }
                        }
                      }
                    }
                  },
                  "iconic": {
                    "summary": "Iconic",
                    "value": {
                      "channelId": "6",
                      "merchantId": "3001",
                      "marketplace": "iconic",
                      "marketplaceSubtype": "iconic",
                      "countryCode": "AUS",
                      "metrics": {
                        "accountHealth": {
                          "returnRate": {
                            "value": 0.125,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "cancellationRate": {
                            "value": 0.008,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "shippedWithin48hRate": {
                            "value": 0.935,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "soldOutProductsCount": {
                            "value": 7,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "missingImageProductsCount": {
                            "value": 2,
                            "status": null,
                            "target": null,
                            "window": null
                          },
                          "poorQualityProductsCount": {
                            "value": 1,
                            "status": null,
                            "target": null,
                            "window": null
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                },
                "examples": {
                  "missingParam": {
                    "summary": "channelId or merchantId missing",
                    "value": {
                      "status": "error",
                      "error": "channelId / merchantId is required"
                    }
                  },
                  "invalidChannel": {
                    "summary": "channelId / merchantId not found or not accessible",
                    "value": {
                      "status": "error",
                      "error": "Invalid channelId / merchantId"
                    }
                  },
                  "unsupportedMarketplace": {
                    "summary": "Marketplace has no seller health support",
                    "value": {
                      "status": "error",
                      "error": "Seller health is not available for this channel"
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": ["error"]
          },
          "error": {
            "type": "string",
            "description": "Human-readable message. Validation failures list every failing rule, comma-separated."
          }
        },
        "example": {
          "status": "error",
          "error": "Invalid request parameters"
        }
      },
      "ApiGatewayForbiddenResponse": {
        "type": "object",
        "description": "Returned for a missing or invalid x-api-key.",
        "properties": { "message": { "type": "string", "enum": ["Forbidden"] } },
        "example": { "message": "Forbidden" }
      },
      "ListReportsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": { "$ref": "#/components/schemas/ReportItem" }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer",
                "description": "Zero-based page index"
              },
              "pageSize": {
                "type": "integer",
                "description": "Number of results per page"
              },
              "count": {
                "type": "integer",
                "description": "Total number of matching reports"
              }
            }
          }
        },
        "example": {
          "pagination": { "pageIndex": 0, "pageSize": 10, "count": 1 },
          "data": [
            {
              "reportId": "6a72ba589131de9029111111",
              "reportName": "Report Demo",
              "reportType": "SINGLE",
              "channels": [
                {
                  "channelId": "1",
                  "channelName": "Seller Demo (USA)",
                  "merchantId": "XXXUS @ ATVPDKIKX0DER",
                  "marketplaceType": "amazon",
                  "marketplaceSubtype": "amazon",
                  "marketplaceCountry": "USA"
                }
              ],
              "recipients": ["demo@merchantspring.com.au"],
              "selectedTags": null,
              "reportingPeriod": {
                "period": "LAST12",
                "fromDate": "2025-08-01T07:00:00.000Z",
                "toDate": "2026-08-01T06:59:59.000Z",
                "comparisonPeriod": "THISYEAR",
                "priorFromDate": "2024-08-01T07:00:00.000Z",
                "priorToDate": "2025-08-01T06:59:59.000Z",
                "timezone": "Australia/Sydney",
                "interval": "MONTH"
              },
              "schedule": {
                "frequency": "m",
                "reportingDelay": 4,
                "reportDay": "5th",
                "reportHour": 6
              },
              "isSent": true,
              "isScheduled": true,
              "reportUrl": "https://merchantspring.io/report?id=6a72ba589131de9029111111",
              "createdAt": "2026-08-05T04:21:44.503Z",
              "updatedAt": null
            }
          ]
        }
      },
      "ReportItem": {
        "type": "object",
        "properties": {
          "reportId": {
            "type": "string",
            "description": "Unique ID of this saved report configuration"
          },
          "reportName": { "type": "string", "description": "Name of the report" },
          "reportType": {
            "type": "string",
            "enum": ["SINGLE", "MULTI"],
            "description": "Whether the report covers a single store or multiple stores"
          },
          "channels": {
            "type": "array",
            "items": { "$ref": "#/components/schemas/ReportChannel" },
            "nullable": true,
            "description": "The report's fixed list of channels - only set for reportType SINGLE. Null for reportType MULTI, where channels are resolved from selectedTags when the report is viewed rather than from a fixed list."
          },
          "recipients": {
            "type": "array",
            "items": { "type": "string" },
            "description": "Who receives this report. For a scheduled report, the people currently on the schedule. Otherwise, everyone it has been sent to. Included intentionally as this only ever reflects recipients for a report the caller is already allowed to see, which is always scoped to the caller's own organisation."
          },
          "selectedTags": {
            "type": "array",
            "items": { "type": "string" },
            "nullable": true,
            "description": "Tags this report's channels are selected by - only set for reportType MULTI. Null for reportType SINGLE."
          },
          "reportingPeriod": { "$ref": "#/components/schemas/ReportingPeriod" },
          "schedule": { "$ref": "#/components/schemas/ReportSchedule" },
          "isSent": {
            "type": "boolean",
            "description": "Whether this report has ever been sent (ad-hoc or via a schedule)"
          },
          "isScheduled": {
            "type": "boolean",
            "description": "Whether this report is currently scheduled"
          },
          "reportUrl": {
            "type": "string",
            "description": "Deep link to view the report (requires a browser session). Included intentionally as this is the same shareable link a user would get from the product itself, meant to be passed around and opened by anyone with access."
          },
          "createdAt": { "type": "string", "format": "date-time" },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "When the report config was last updated - null if never updated since creation"
          }
        }
      },
      "ReportSchedule": {
        "type": "object",
        "properties": {
          "frequency": {
            "type": "string",
            "nullable": true,
            "enum": ["d", "w", "m", null],
            "description": "How often the report is sent: daily, weekly, or monthly. Null when isScheduled is false."
          },
          "reportingDelay": {
            "type": "integer",
            "nullable": true,
            "description": "Number of days between the scheduled reporting date and when the report is sent. For example, on a monthly schedule, a reportingDelay of 4 sends the report on the 5th of each month.",
            "example": 4
          },
          "reportDay": {
            "type": "string",
            "nullable": true,
            "description": "Day the report is sent on. For weekly schedules, a weekday like 'Mon'. For monthly schedules, a day of month like '5th'. Not used for daily schedules. Null when isScheduled is false."
          },
          "reportHour": {
            "type": "integer",
            "nullable": true,
            "description": "Hour of day (0-23, local to timezone) the schedule sends at - only set when isScheduled is true"
          }
        }
      },
      "ReportingPeriod": {
        "type": "object",
        "properties": {
          "period": {
            "type": "string",
            "enum": [
              "TODAY",
              "YESTERDAY",
              "WTD",
              "WTDMTS",
              "LAST30",
              "MTD",
              "CURRENTMONTH",
              "LASTMONTH",
              "CURRENTQ",
              "LASTQ",
              "LAST12",
              "YTD",
              "CURRENTYEAR",
              "CUSTOM"
            ],
            "description": "The report's date range, e.g. LAST12 for the trailing 12 months."
          },
          "fromDate": {
            "type": "string",
            "format": "date-time",
            "description": "Start of the report's date range."
          },
          "toDate": {
            "type": "string",
            "format": "date-time",
            "description": "End of the report's date range."
          },
          "comparisonPeriod": {
            "type": "string",
            "enum": ["THISYEAR", "LASTYEAR", "PREVIOUSFISCALPERIOD"],
            "description": "The period the report is compared against, e.g. LASTYEAR."
          },
          "priorFromDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Start of the comparison date range. Null when the report has no comparison range stored."
          },
          "priorToDate": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "End of the comparison date range. Null when the report has no comparison range stored."
          },
          "timezone": {
            "type": "string",
            "description": "Timezone used for the report's dates, e.g. 'Australia/Sydney'."
          },
          "interval": {
            "type": "string",
            "nullable": true,
            "description": "How the data is grouped in charts, e.g. by day, week, or month. Null if not applicable."
          }
        }
      },
      "ReportChannel": {
        "type": "object",
        "properties": {
          "channelId": { "type": "string", "description": "Store/channel ID" },
          "channelName": { "type": "string", "description": "Store display name" },
          "merchantId": { "type": "string", "description": "Merchant ID" },
          "marketplaceType": {
            "type": "string",
            "description": "Marketplace type (e.g. amazon, walmart)"
          },
          "marketplaceSubtype": {
            "type": "string",
            "description": "Marketplace subtype (e.g. amazon, amazon_vendor)"
          },
          "marketplaceCountry": {
            "type": "string",
            "description": "Marketplace country code"
          }
        }
      },
      "StartEndTimeRange": {
        "type": "object",
        "description": "Start and end of a time range. ISO 8601 values preserve the UTC offset for the requested timezone; epoch values are Unix seconds for the same instants.",
        "required": ["startTime", "endTime", "startTimeEpoch", "endTimeEpoch"],
        "properties": {
          "startTime": {
            "type": "string",
            "format": "date-time",
            "description": "Range start in ISO 8601 format with the requested timezone's UTC offset."
          },
          "endTime": {
            "type": "string",
            "format": "date-time",
            "description": "Inclusive range end in ISO 8601 format with the requested timezone's UTC offset."
          },
          "startTimeEpoch": {
            "type": "integer",
            "format": "int64",
            "description": "Range start as Unix epoch seconds."
          },
          "endTimeEpoch": {
            "type": "integer",
            "format": "int64",
            "description": "Inclusive range end as Unix epoch seconds."
          }
        }
      },
      "ForecastTargets": {
        "type": "object",
        "description": "Ad Spend Budget, Sales Budget, Sales Forecast. Amounts are in the currency reported in meta.currency; null means no target has been set.",
        "properties": {
          "salesBudget": {
            "type": "number",
            "nullable": true
          },
          "salesForecast": {
            "type": "number",
            "nullable": true
          },
          "adSpendBudget": {
            "type": "number",
            "nullable": true
          }
        },
        "example": {
          "salesBudget": null,
          "salesForecast": null,
          "adSpendBudget": 0.35
        }
      },
      "TargetsBucket": {
        "allOf": [
          {
            "$ref": "#/components/schemas/StartEndTimeRange"
          },
          {
            "$ref": "#/components/schemas/ForecastTargets"
          }
        ]
      },
      "getTargetsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "description": "Chronologically ordered, with one entry per interval bucket.",
            "items": {
              "$ref": "#/components/schemas/TargetsBucket"
            }
          },
          "totals": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ForecastTargets"
              },
              {
                "description": "Summed roll-up across the whole range."
              }
            ]
          },
          "meta": {
            "type": "object",
            "properties": {
              "timezone": {
                "type": "string"
              },
              "currency": {
                "type": "string"
              }
            }
          }
        },
        "example": {
          "data": [
            {
              "startTime": "2025-07-20T00:00:00.000+10:00",
              "endTime": "2025-07-20T23:59:59.000+10:00",
              "startTimeEpoch": 1752933600,
              "endTimeEpoch": 1753019999,
              "salesBudget": null,
              "salesForecast": null,
              "adSpendBudget": 0.35
            }
          ],
          "totals": {
            "salesBudget": null,
            "salesForecast": null,
            "adSpendBudget": 0.35
          },
          "meta": {
            "timezone": "Australia/Sydney",
            "currency": "USD"
          }
        }
      },
      "ProductAttributeResponse": {
        "type": "object",
        "required": ["data"],
        "properties": {
          "data": {
            "type": "object",
            "nullable": true,
            "description": "Null when no catalog item or listings exist for the ASIN.",
            "allOf": [
              {
                "$ref": "#/components/schemas/ProductAttribute"
              }
            ]
          }
        },
        "example": {
          "data": {
            "channelType": "seller",
            "asin": "B0020MMCJI",
            "summaries": {
              "marketplaceId": "ATVPDKIKX0DER",
              "brandName": "A Touch Of Style",
              "itemName": "Classic Eau de Toilette for Men - Citrusy and Earthy Scent"
            },
            "attributes": {
              "brand": [
                {
                  "language_tag": "en_US",
                  "marketplace_id": "ATVPDKIKX0DER",
                  "value": "A Touch Of Style"
                }
              ],
              "bullet_point": [
                {
                  "language_tag": "en_US",
                  "marketplace_id": "ATVPDKIKX0DER",
                  "value": "New range of formal shirts are designed keeping you in mind. With fits and styling that will make you stand apart"
                },
                {
                  "language_tag": "en_US",
                  "marketplace_id": "ATVPDKIKX0DER",
                  "value": "New range of formal shirts are designed keeping you in mind. With fits and styling that will make you stand apart"
                }
              ],
              "item_name": [
                {
                  "language_tag": "en_US",
                  "marketplace_id": "ATVPDKIKX0DER",
                  "value": "Classic Eau de Toilette for Men - Citrusy and Earthy Scent"
                }
              ]
            },
            "identifiers": [
              {
                "identifier": "688772402712",
                "identifierType": "UPC"
              }
            ],
            "images": [
              {
                "variant": "MAIN",
                "link": "https://m.media-amazon.com/images/I/51C+9Ww5AaL.*SL1000*.jpg",
                "height": 500,
                "width": 500
              }
            ],
            "salesRanks": {
              "marketplaceId": "ATVPDKIKX0DER",
              "classificationRanks": [
                {
                  "classificationId": "14024031",
                  "title": "Lotions",
                  "link": "https://www.amazon.com/gp/bestsellers/beauty/14024031",
                  "rank": 385
                }
              ]
            },
            "classifications": [
              {
                "classificationId": "14024031",
                "displayName": "Lotions",
                "parent": {
                  "classificationId": "11060661",
                  "displayName": "Moisturizers",
                  "parent": {
                    "classificationId": "11060521",
                    "displayName": "Body",
                    "parent": {
                      "classificationId": "11060451",
                      "displayName": "Skin Care",
                      "parent": {
                        "classificationId": "11055981",
                        "displayName": "Products",
                        "parent": {
                          "classificationId": "3760911",
                          "displayName": "Beauty & Personal Care"
                        }
                      }
                    }
                  }
                }
              }
            ],
            "productTypes": ["BEAUTY"],
            "relationships": [],
            "sellerListings": [
              {
                "offers": [
                  {
                    "marketplaceId": "ATVPDKIKX0DER",
                    "offerType": "B2C",
                    "price": {
                      "currency": "USD",
                      "amount": "19.99"
                    }
                  }
                ],
                "fulfillmentAvailability": [
                  {
                    "fulfillmentChannelCode": "AMAZON_NA",
                    "quantity": 10
                  }
                ],
                "issues": [],
                "sku": "LOCAL-B0020MMCJI",
                "status": ["BUYABLE"],
                "conditionType": "new_new",
                "createdDate": "2026-07-23T07:50:56.276Z",
                "lastUpdatedDate": "2026-07-23T07:50:56.276Z"
              }
            ],
            "vendorListing": null
          }
        }
      },
      "ProductAttribute": {
        "type": "object",
        "required": [
          "channelType",
          "asin",
          "summaries",
          "attributes",
          "identifiers",
          "images",
          "salesRanks",
          "classifications",
          "productTypes",
          "relationships",
          "sellerListings",
          "vendorListing"
        ],
        "properties": {
          "channelType": {
            "type": "string",
            "enum": ["seller", "vendor"]
          },
          "asin": {
            "type": "string",
            "example": "B0020MMCJI"
          },
          "summaries": {
            "type": "object",
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/AmazonProductSummary"
              }
            ]
          },
          "attributes": {
            "type": "object",
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/AmazonCatalogAttributes"
              }
            ]
          },
          "identifiers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonProductIdentifier"
            }
          },
          "images": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonProductImage"
            }
          },
          "salesRanks": {
            "type": "object",
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/AmazonSalesRanks"
              }
            ]
          },
          "classifications": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonProductClassification"
            }
          },
          "productTypes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": ["BEAUTY"]
          },
          "relationships": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonProductRelationship"
            }
          },
          "sellerListings": {
            "type": "array",
            "nullable": true,
            "description": "Seller SKU-level data. Null for vendor channels.",
            "items": {
              "$ref": "#/components/schemas/AmazonSellerListing"
            }
          },
          "vendorListing": {
            "type": "object",
            "nullable": true,
            "description": "Vendor-specific data. Null for seller channels.",
            "allOf": [
              {
                "$ref": "#/components/schemas/AmazonVendorListing"
              }
            ]
          }
        }
      },
      "AmazonProductSummary": {
        "type": "object",
        "required": ["marketplaceId"],
        "properties": {
          "marketplaceId": {
            "type": "string",
            "example": "ATVPDKIKX0DER"
          },
          "brand": {
            "type": "string"
          },
          "brandName": {
            "type": "string",
            "example": "A Touch Of Style"
          },
          "itemClassification": {
            "type": "string",
            "enum": [
              "BASE_PRODUCT",
              "OTHER",
              "PRODUCT_BUNDLE",
              "VARIATION_PARENT"
            ]
          },
          "color": {
            "type": "string"
          },
          "itemName": {
            "type": "string",
            "example": "Classic Eau de Toilette for Men - Citrusy and Earthy Scent"
          },
          "manufacturer": {
            "type": "string"
          },
          "modelNumber": {
            "type": "string"
          },
          "packageQuantity": {
            "type": "integer",
            "format": "int32"
          },
          "partNumber": {
            "type": "string"
          },
          "size": {
            "type": "string"
          },
          "style": {
            "type": "string"
          },
          "websiteDisplayGroup": {
            "type": "string"
          },
          "websiteDisplayGroupName": {
            "type": "string"
          }
        }
      },
      "AmazonCatalogAttributes": {
        "type": "object",
        "description": "Catalog attributes returned by Amazon.",
        "properties": {
          "brand": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonCatalogTextAttribute"
            }
          },
          "bullet_point": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonCatalogTextAttribute"
            }
          },
          "item_name": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonCatalogTextAttribute"
            }
          }
        }
      },
      "AmazonCatalogTextAttribute": {
        "type": "object",
        "required": ["marketplace_id", "value"],
        "properties": {
          "language_tag": {
            "type": "string",
            "example": "en_US"
          },
          "marketplace_id": {
            "type": "string",
            "example": "ATVPDKIKX0DER"
          },
          "value": {
            "type": "string",
            "example": "A Touch Of Style"
          }
        }
      },
      "AmazonProductIdentifier": {
        "type": "object",
        "required": ["identifier", "identifierType"],
        "properties": {
          "identifier": {
            "type": "string",
            "example": "688772402712"
          },
          "identifierType": {
            "type": "string",
            "example": "UPC"
          }
        }
      },
      "AmazonProductImage": {
        "type": "object",
        "required": ["variant", "link", "height", "width"],
        "properties": {
          "variant": {
            "type": "string",
            "example": "MAIN"
          },
          "link": {
            "type": "string",
            "format": "uri",
            "example": "https://m.media-amazon.com/images/I/51C+9Ww5AaL.*SL1000*.jpg"
          },
          "height": {
            "type": "integer",
            "format": "int32",
            "example": 500
          },
          "width": {
            "type": "integer",
            "format": "int32",
            "example": 500
          }
        }
      },
      "AmazonSalesRanks": {
        "type": "object",
        "required": ["marketplaceId"],
        "properties": {
          "marketplaceId": {
            "type": "string",
            "example": "ATVPDKIKX0DER"
          },
          "classificationRanks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonClassificationRank"
            }
          },
          "displayGroupRanks": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonDisplayGroupRank"
            }
          }
        }
      },
      "AmazonClassificationRank": {
        "type": "object",
        "required": ["classificationId", "title", "link", "rank"],
        "properties": {
          "classificationId": {
            "type": "string",
            "example": "14024031"
          },
          "title": {
            "type": "string",
            "example": "Lotions"
          },
          "link": {
            "type": "string",
            "format": "uri",
            "example": "https://www.amazon.com/gp/bestsellers/beauty/14024031"
          },
          "rank": {
            "type": "integer",
            "format": "int32",
            "example": 385
          }
        }
      },
      "AmazonDisplayGroupRank": {
        "type": "object",
        "required": ["websiteDisplayGroup", "title", "link", "rank"],
        "properties": {
          "websiteDisplayGroup": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "link": {
            "type": "string",
            "format": "uri"
          },
          "rank": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "AmazonProductClassification": {
        "type": "object",
        "required": ["classificationId", "displayName"],
        "properties": {
          "classificationId": {
            "type": "string",
            "example": "14024031"
          },
          "displayName": {
            "type": "string",
            "example": "Lotions"
          },
          "parent": {
            "type": "object",
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/AmazonProductClassification"
              }
            ]
          }
        }
      },
      "AmazonProductRelationship": {
        "type": "object",
        "required": ["type"],
        "properties": {
          "type": {
            "type": "string",
            "enum": ["VARIATION", "PACKAGE_HIERARCHY"]
          },
          "childAsins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "parentAsins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "AmazonSellerListing": {
        "type": "object",
        "required": ["sku", "offers", "fulfillmentAvailability", "issues"],
        "properties": {
          "offers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonListingOffer"
            }
          },
          "fulfillmentAvailability": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonFulfillmentAvailability"
            }
          },
          "issues": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AmazonListingIssue"
            }
          },
          "sku": {
            "type": "string",
            "example": "LOCAL-B0020MMCJI"
          },
          "status": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": ["BUYABLE"]
          },
          "conditionType": {
            "type": "string",
            "example": "new_new"
          },
          "createdDate": {
            "type": "string",
            "format": "date-time",
            "example": "2026-07-23T07:50:56.276Z"
          },
          "lastUpdatedDate": {
            "type": "string",
            "format": "date-time",
            "example": "2026-07-23T07:50:56.276Z"
          }
        }
      },
      "AmazonListingOffer": {
        "type": "object",
        "required": ["marketplaceId", "offerType", "price"],
        "properties": {
          "marketplaceId": {
            "type": "string",
            "example": "ATVPDKIKX0DER"
          },
          "offerType": {
            "type": "string",
            "example": "B2C"
          },
          "price": {
            "$ref": "#/components/schemas/AmazonListingPrice"
          }
        }
      },
      "AmazonListingPrice": {
        "type": "object",
        "required": ["currency", "amount"],
        "properties": {
          "currency": {
            "type": "string",
            "example": "USD"
          },
          "amount": {
            "type": "string",
            "example": "19.99"
          }
        }
      },
      "AmazonFulfillmentAvailability": {
        "type": "object",
        "required": ["fulfillmentChannelCode", "quantity"],
        "properties": {
          "fulfillmentChannelCode": {
            "type": "string",
            "example": "AMAZON_NA"
          },
          "quantity": {
            "type": "integer",
            "format": "int32",
            "example": 10
          }
        }
      },
      "AmazonListingIssue": {
        "type": "object",
        "required": ["message", "severity", "attributeNames"],
        "properties": {
          "message": {
            "type": "string"
          },
          "severity": {
            "type": "string"
          },
          "attributeNames": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "AmazonVendorListing": {
        "type": "object",
        "required": ["vendorDetails", "procurement", "vendorCode"],
        "properties": {
          "vendorDetails": {
            "type": "object",
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/AmazonVendorDetails"
              }
            ]
          },
          "procurement": {
            "type": "array",
            "description": "Vendor procurement info from the listings item. Empty array when absent.",
            "items": {
              "$ref": "#/components/schemas/AmazonProcurement"
            }
          },
          "vendorCode": {
            "type": "string",
            "nullable": true,
            "example": "ABCDE"
          }
        }
      },
      "AmazonProcurement": {
        "type": "object",
        "required": ["costPrice"],
        "properties": {
          "costPrice": {
            "type": "object",
            "required": ["currencyCode", "amount"],
            "properties": {
              "currencyCode": {
                "type": "string",
                "example": "USD"
              },
              "amount": {
                "type": "string",
                "example": "12.50"
              },
              "currency": {
                "type": "string",
                "example": "USD"
              }
            }
          }
        }
      },
      "AmazonVendorDetails": {
        "type": "object",
        "required": [
          "brandCode",
          "manufacturerCode",
          "manufacturerCodeParent",
          "marketplaceId",
          "productCategory",
          "productGroup",
          "productSubcategory",
          "replenishmentCategory"
        ],
        "properties": {
          "brandCode": {
            "type": "string"
          },
          "manufacturerCode": {
            "type": "string"
          },
          "manufacturerCodeParent": {
            "type": "string"
          },
          "marketplaceId": {
            "type": "string",
            "example": "ATVPDKIKX0DER"
          },
          "productCategory": {
            "$ref": "#/components/schemas/AmazonVendorCategory"
          },
          "productGroup": {
            "type": "string"
          },
          "productSubcategory": {
            "$ref": "#/components/schemas/AmazonVendorCategory"
          },
          "replenishmentCategory": {
            "type": "string"
          }
        }
      },
      "AmazonVendorCategory": {
        "type": "object",
        "required": ["displayName", "value"],
        "properties": {
          "displayName": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "SqpResolvedDateRange": {
        "type": "object",
        "description": "The date range actually used to compute this data. SQP reports are monthly, so the requested currentRange is clipped to the start/end of its containing calendar month(s) - this may differ from what was requested.",
        "properties": {
          "fromDate": {
            "type": "string",
            "description": "Start of the current period actually used (YYYY-MM-DD)"
          },
          "toDate": {
            "type": "string",
            "description": "End of the current period actually used (YYYY-MM-DD)"
          },
          "priorFromDate": {
            "type": "string",
            "description": "Start of the comparison period actually used (YYYY-MM-DD)"
          },
          "priorToDate": {
            "type": "string",
            "description": "End of the comparison period actually used (YYYY-MM-DD)"
          }
        }
      },
      "SqpMetrics": {
        "type": "object",
        "properties": {
          "searchQueryVolume": {
            "type": "number"
          },
          "totalImpressions": {
            "type": "number"
          },
          "impressions": {
            "type": "number"
          },
          "impressionShare": {
            "type": "number"
          },
          "totalClicks": {
            "type": "number"
          },
          "clicks": {
            "type": "number"
          },
          "clickShare": {
            "type": "number"
          },
          "totalCtr": {
            "type": "number"
          },
          "ctr": {
            "type": "number"
          },
          "totalCartAdds": {
            "type": "number"
          },
          "cartAdds": {
            "type": "number"
          },
          "atcRate": {
            "type": "number"
          },
          "totalPurchases": {
            "type": "number"
          },
          "purchases": {
            "type": "number"
          },
          "purchaseShare": {
            "type": "number"
          },
          "totalCvr": {
            "type": "number"
          },
          "cvr": {
            "type": "number"
          },
          "currentRevenue": {
            "type": "number"
          },
          "currencyCode": {
            "type": "string",
            "description": "Matches the top-level meta.currency - the currency currentRevenue was converted into"
          }
        }
      },
      "GetSqpAsinTableResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "asin": {
                  "type": "string"
                },
                "current": {
                  "$ref": "#/components/schemas/SqpMetrics"
                },
                "prior": {
                  "$ref": "#/components/schemas/SqpMetrics"
                }
              }
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer",
                "description": "Zero-based page index"
              },
              "pageSize": {
                "type": "integer",
                "description": "Number of results per page"
              },
              "count": {
                "type": "integer",
                "description": "Total number of matching ASINs (across all pages)"
              }
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string",
                "description": "Currency all monetary values (e.g. current/prior currentRevenue) were converted into"
              },
              "dateRange": {
                "$ref": "#/components/schemas/SqpResolvedDateRange"
              }
            }
          }
        }
      },
      "GetSqpKeywordTableResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "searchQuery": {
                  "type": "string"
                },
                "current": {
                  "$ref": "#/components/schemas/SqpMetrics"
                },
                "prior": {
                  "$ref": "#/components/schemas/SqpMetrics"
                }
              }
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer",
                "description": "Zero-based page index"
              },
              "pageSize": {
                "type": "integer",
                "description": "Number of results per page"
              },
              "count": {
                "type": "integer",
                "description": "Total number of matching search queries (across all pages)"
              }
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string",
                "description": "Currency all monetary values (e.g. current/prior currentRevenue) were converted into"
              },
              "dateRange": {
                "$ref": "#/components/schemas/SqpResolvedDateRange"
              }
            }
          }
        }
      },
      "GetAdvertisingCampaignsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "channel_id": {
                  "type": "string"
                },
                "campaign_id": {
                  "type": "string"
                },
                "ad_type": {
                  "type": "string"
                },
                "campaign_name": {
                  "type": "string"
                },
                "campaign_status": {
                  "type": "string"
                },
                "budget": {
                  "type": "number"
                },
                "budget_type": {
                  "type": "string"
                },
                "start_date": {
                  "type": "string",
                  "nullable": true
                },
                "end_date": {
                  "type": "string",
                  "nullable": true
                },
                "targeting_type": {
                  "type": "string",
                  "nullable": true
                },
                "bidding_strategy": {
                  "type": "string",
                  "nullable": true
                },
                "cost_type": {
                  "type": "string",
                  "nullable": true
                },
                "impressions": {
                  "type": "number"
                },
                "clicks": {
                  "type": "number"
                },
                "cost": {
                  "type": "number"
                },
                "attributed_sales": {
                  "type": "number"
                },
                "attributed_sales_same_sku": {
                  "type": "number"
                },
                "attributed_conversions": {
                  "type": "number"
                },
                "attributed_conversions_same_sku": {
                  "type": "number"
                },
                "attributed_units_ordered": {
                  "type": "number"
                },
                "attributed_units_ordered_same_sku": {
                  "type": "number"
                },
                "attributed_orders_ntb": {
                  "type": "number"
                },
                "attributed_units_ordered_ntb": {
                  "type": "number"
                },
                "attributed_sales_ntb": {
                  "type": "number"
                },
                "attributed_orders_ntb_percentage": {
                  "type": "number",
                  "nullable": true
                },
                "attributed_units_ordered_ntb_percentage": {
                  "type": "number",
                  "nullable": true
                },
                "attributed_sales_ntb_percentage": {
                  "type": "number",
                  "nullable": true
                },
                "attributed_detail_page_views_clicks": {
                  "type": "number"
                },
                "acos": {
                  "type": "number"
                },
                "click_through_rate": {
                  "type": "number"
                },
                "cost_per_click": {
                  "type": "number"
                },
                "cost_per_acquisition": {
                  "type": "number"
                },
                "conversion_rate": {
                  "type": "number"
                },
                "roas": {
                  "type": "number"
                }
              }
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer"
              },
              "pageSize": {
                "type": "integer"
              },
              "count": {
                "type": "integer"
              }
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string"
              }
            }
          }
        }
      },
      "GetAdvertisingAdGroupsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "channel_id": {
                  "type": "string"
                },
                "campaign_id": {
                  "type": "string"
                },
                "ad_group_id": {
                  "type": "string"
                },
                "ad_type": {
                  "type": "string"
                },
                "campaign_name": {
                  "type": "string"
                },
                "ad_group_name": {
                  "type": "string"
                },
                "ad_group_status": {
                  "type": "string"
                },
                "default_bid": {
                  "type": "number",
                  "nullable": true
                },
                "cost_type": {
                  "type": "string",
                  "nullable": true
                },
                "impressions": {
                  "type": "number"
                },
                "clicks": {
                  "type": "number"
                },
                "cost": {
                  "type": "number"
                },
                "attributed_sales": {
                  "type": "number"
                },
                "attributed_sales_same_sku": {
                  "type": "number"
                },
                "attributed_conversions": {
                  "type": "number"
                },
                "attributed_conversions_same_sku": {
                  "type": "number"
                },
                "attributed_units_ordered": {
                  "type": "number"
                },
                "attributed_units_ordered_same_sku": {
                  "type": "number"
                },
                "attributed_orders_ntb": {
                  "type": "number"
                },
                "attributed_units_ordered_ntb": {
                  "type": "number"
                },
                "attributed_sales_ntb": {
                  "type": "number"
                },
                "attributed_orders_ntb_percentage": {
                  "type": "number",
                  "nullable": true
                },
                "attributed_units_ordered_ntb_percentage": {
                  "type": "number",
                  "nullable": true
                },
                "attributed_sales_ntb_percentage": {
                  "type": "number",
                  "nullable": true
                },
                "attributed_detail_page_views_clicks": {
                  "type": "number"
                },
                "acos": {
                  "type": "number"
                },
                "click_through_rate": {
                  "type": "number"
                },
                "cost_per_click": {
                  "type": "number"
                },
                "conversion_rate": {
                  "type": "number"
                },
                "roas": {
                  "type": "number"
                }
              }
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer"
              },
              "pageSize": {
                "type": "integer"
              },
              "count": {
                "type": "integer"
              }
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string"
              }
            }
          }
        }
      },
      "GetAdvertisingProductsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "channel_id": {
                  "type": "string"
                },
                "product_sku": {
                  "type": "string",
                  "description": "Normalised product identifier — an ASIN on Amazon, or the equivalent product identifier the channel's platform uses."
                },
                "impressions": {
                  "type": "number"
                },
                "clicks": {
                  "type": "number"
                },
                "cost": {
                  "type": "number"
                },
                "attributed_sales": {
                  "type": "number"
                },
                "attributed_sales_same_sku": {
                  "type": "number"
                },
                "attributed_conversions": {
                  "type": "number"
                },
                "attributed_conversions_same_sku": {
                  "type": "number"
                },
                "attributed_units_ordered": {
                  "type": "number"
                },
                "attributed_units_ordered_same_sku": {
                  "type": "number"
                },
                "acos": {
                  "type": "number"
                },
                "click_through_rate": {
                  "type": "number"
                },
                "cost_per_click": {
                  "type": "number"
                },
                "conversion_rate": {
                  "type": "number"
                },
                "roas": {
                  "type": "number"
                },
                "product_title": {
                  "type": "string",
                  "nullable": true
                },
                "image_url": {
                  "type": "string",
                  "nullable": true
                },
                "link_url": {
                  "type": "string",
                  "nullable": true
                }
              }
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer"
              },
              "pageSize": {
                "type": "integer"
              },
              "count": {
                "type": "integer"
              }
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string"
              }
            }
          }
        }
      },
      "GetAdvertisingKeywordsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "channel_id": {
                  "type": "string"
                },
                "campaign_id": {
                  "type": "string"
                },
                "ad_group_id": {
                  "type": "string"
                },
                "keyword_id": {
                  "type": "string"
                },
                "ad_type": {
                  "type": "string"
                },
                "campaign_name": {
                  "type": "string"
                },
                "ad_group_name": {
                  "type": "string"
                },
                "keyword_text": {
                  "type": "string"
                },
                "match_type": {
                  "type": "string"
                },
                "keyword_status": {
                  "type": "string"
                },
                "bid": {
                  "type": "number",
                  "nullable": true
                },
                "cost_type": {
                  "type": "string",
                  "nullable": true
                },
                "impressions": {
                  "type": "number"
                },
                "clicks": {
                  "type": "number"
                },
                "cost": {
                  "type": "number"
                },
                "attributed_sales": {
                  "type": "number"
                },
                "attributed_sales_same_sku": {
                  "type": "number"
                },
                "attributed_conversions": {
                  "type": "number"
                },
                "attributed_conversions_same_sku": {
                  "type": "number"
                },
                "attributed_units_ordered": {
                  "type": "number"
                },
                "attributed_units_ordered_same_sku": {
                  "type": "number"
                },
                "attributed_orders_ntb": {
                  "type": "number"
                },
                "attributed_units_ordered_ntb": {
                  "type": "number"
                },
                "attributed_sales_ntb": {
                  "type": "number"
                },
                "attributed_detail_page_views_clicks": {
                  "type": "number"
                },
                "attributed_orders_ntb_percentage": {
                  "type": "number"
                },
                "attributed_units_ordered_ntb_percentage": {
                  "type": "number"
                },
                "attributed_sales_ntb_percentage": {
                  "type": "number"
                },
                "acos": {
                  "type": "number"
                },
                "click_through_rate": {
                  "type": "number"
                },
                "cost_per_click": {
                  "type": "number"
                },
                "conversion_rate": {
                  "type": "number"
                },
                "cost_per_acquisition": {
                  "type": "number"
                },
                "roas": {
                  "type": "number"
                }
              }
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer"
              },
              "pageSize": {
                "type": "integer"
              },
              "count": {
                "type": "integer"
              }
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string"
              }
            }
          }
        }
      },
      "GetAdvertisingSearchTermsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "channel_id": {
                  "type": "string"
                },
                "ad_type": {
                  "type": "string"
                },
                "search_term": {
                  "type": "string"
                },
                "impressions": {
                  "type": "number"
                },
                "clicks": {
                  "type": "number"
                },
                "cost": {
                  "type": "number"
                },
                "attributed_sales": {
                  "type": "number"
                },
                "attributed_sales_same_sku": {
                  "type": "number",
                  "description": "Always 0 for ad_type SB - Sponsored Brands reports have no same-SKU breakdown."
                },
                "attributed_conversions": {
                  "type": "number"
                },
                "attributed_conversions_same_sku": {
                  "type": "number",
                  "description": "Always 0 for ad_type SB - Sponsored Brands reports have no same-SKU breakdown."
                },
                "attributed_units_ordered": {
                  "type": "number"
                },
                "attributed_units_ordered_same_sku": {
                  "type": "number",
                  "description": "Always 0 for ad_type SB - Sponsored Brands reports have no same-SKU breakdown."
                },
                "acos": {
                  "type": "number",
                  "nullable": true,
                  "description": "null when attributed_sales is 0 - there are no sales to measure spend against."
                },
                "click_through_rate": {
                  "type": "number"
                },
                "cost_per_click": {
                  "type": "number"
                },
                "conversion_rate": {
                  "type": "number"
                },
                "cost_per_acquisition": {
                  "type": "number"
                },
                "roas": {
                  "type": "number",
                  "nullable": true,
                  "description": "null when cost is 0."
                }
              }
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer"
              },
              "pageSize": {
                "type": "integer"
              },
              "count": {
                "type": "integer"
              }
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string"
              }
            }
          }
        }
      },
      "GetAsinDetailsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UnifiedAsinProduct"
            }
          },
          "pagination": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer",
                "description": "Zero-based page index"
              },
              "pageSize": {
                "type": "integer",
                "description": "Number of ASINs per page"
              },
              "count": {
                "type": "integer",
                "description": "Total ASINs in the master list (products with sales activity in the window)"
              }
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "currency": {
                "type": "string",
                "description": "Currency of all monetary values (native marketplace currency)"
              }
            }
          }
        }
      },
      "VendorShippedRevenueMetrics": {
        "type": "object",
        "properties": {
          "shippedRevenue": {
            "type": "number"
          },
          "shippedUnits": {
            "type": "integer"
          },
          "shippedCogs": {
            "type": "number"
          },
          "customerReturns": {
            "type": "integer"
          },
          "unitCogs": {
            "type": "number"
          },
          "rawMargin": {
            "type": "number",
            "description": "(rev − cogs) / rev × 100"
          },
          "netPpm": {
            "type": "number",
            "description": "Revenue-weighted net pure product margin"
          }
        }
      },
      "UnifiedAsinProduct": {
        "type": "object",
        "description": "One ASIN's data, namespaced by source screen. Some monetary metrics intentionally repeat across groups, mirroring the source screens.",
        "properties": {
          "asin": {
            "type": "string"
          },
          "catalogue": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string"
              },
              "vpi": {
                "type": "string",
                "description": "Vendor product identifier (seller_sku)"
              },
              "brand": {
                "type": "string"
              },
              "category": {
                "type": "string"
              },
              "parentCategory": {
                "type": "string"
              },
              "retailPrice": {
                "type": "number",
                "description": "Catalogue/list price (product_metric, fallback product)"
              },
              "imageUrl": {
                "type": "string"
              },
              "linkUrl": {
                "type": "string"
              },
              "isFulfilledByAmazon": {
                "type": "boolean"
              }
            }
          },
          "orderedRevenue": {
            "type": "object",
            "properties": {
              "glanceViews": {
                "type": "number"
              },
              "lostFeaturedOffer": {
                "type": "number"
              },
              "orderedRevenue": {
                "type": "number"
              },
              "orderedUnits": {
                "type": "integer"
              },
              "conversionRate": {
                "type": "number",
                "description": "ordered units / glance views × 100"
              },
              "retailPrice": {
                "type": "number",
                "description": "Average selling price (ordered $ / units). The catalogue list price is catalogue.retailPrice."
              }
            }
          },
          "shippedRevenue": {
            "type": "object",
            "description": "Sourcing is what you shipped to Amazon; manufacturing is the product total across all vendors.",
            "properties": {
              "sourcing": {
                "$ref": "#/components/schemas/VendorShippedRevenueMetrics"
              },
              "manufacturing": {
                "$ref": "#/components/schemas/VendorShippedRevenueMetrics"
              }
            }
          },
          "inventory": {
            "type": "object",
            "properties": {
              "sellableInventory": {
                "type": "number"
              },
              "unhealthyInventory": {
                "type": "number"
              },
              "aged90Plus": {
                "type": "number"
              },
              "sellableUnits": {
                "type": "integer"
              },
              "unhealthyUnits": {
                "type": "integer"
              },
              "aged90PlusUnits": {
                "type": "integer"
              },
              "unsellableInventory": {
                "type": "number"
              },
              "receivedInventory": {
                "type": "number"
              },
              "receivedUnits": {
                "type": "integer"
              },
              "unitsShipped": {
                "type": "integer"
              },
              "daysCover": {
                "type": "number",
                "nullable": true,
                "description": "sellable units / trailing-30-day sales rate; null when no recent sales"
              },
              "openPo": {
                "type": "integer"
              },
              "unfilledUnits": {
                "type": "integer"
              },
              "sellThroughRate": {
                "type": "number"
              },
              "vendorLeadTimeDays": {
                "type": "number"
              },
              "netFilledRate": {
                "type": "number"
              },
              "sourceableOosPct": {
                "type": "number"
              },
              "procurableOosPct": {
                "type": "number"
              }
            }
          },
          "po": {
            "type": "object",
            "properties": {
              "price": {
                "type": "number",
                "description": "Average per-unit list price"
              },
              "poValue": {
                "type": "number",
                "description": "Accepted PO value (sum of po_value)"
              },
              "unitsOrdered": {
                "type": "integer",
                "description": "Sum of submitted units"
              },
              "avgPrice": {
                "type": "number",
                "description": "PO value / submitted units"
              },
              "daysSinceLastOrder": {
                "type": "integer",
                "nullable": true
              }
            }
          },
          "profit": {
            "type": "object",
            "properties": {
              "adSales": {
                "type": "number"
              },
              "adSpend": {
                "type": "number"
              },
              "acos": {
                "type": "number"
              },
              "tacos": {
                "type": "number"
              },
              "shippedCogs": {
                "type": "number"
              },
              "advertisingCost": {
                "type": "number"
              },
              "unitsShipped": {
                "type": "integer"
              },
              "deductions": {
                "type": "number"
              },
              "cogs": {
                "type": "number"
              },
              "chargebacks": {
                "type": "number"
              },
              "expenses": {
                "type": "number"
              },
              "profit": {
                "type": "number"
              },
              "inventory": {
                "type": "number",
                "description": "Sellable inventory units"
              },
              "snsUnits": {
                "type": "integer",
                "nullable": true,
                "description": "Subscribe & Save units; null only if unavailable"
              }
            }
          },
          "sourcingShare": {
            "type": "object",
            "properties": {
              "lostCogsUsa": {
                "type": "number"
              },
              "lostUnitsUsa": {
                "type": "integer"
              },
              "sourcingShareUsa": {
                "type": "number"
              },
              "unitCogs": {
                "type": "number"
              },
              "exportedCogs": {
                "type": "number"
              },
              "exportedUnits": {
                "type": "integer"
              },
              "exportPct": {
                "type": "number"
              },
              "otherVendors": {
                "type": "number",
                "description": "Other-vendor cost per unit"
              }
            }
          },
          "advertising": {
            "type": "object",
            "properties": {
              "adSales": {
                "type": "number"
              },
              "spend": {
                "type": "number"
              },
              "acos": {
                "type": "number"
              },
              "impressions": {
                "type": "integer"
              },
              "clicks": {
                "type": "integer"
              },
              "ctr": {
                "type": "number"
              },
              "cpc": {
                "type": "number"
              },
              "conv": {
                "type": "number"
              },
              "orders": {
                "type": "integer"
              },
              "units": {
                "type": "integer"
              },
              "roas": {
                "type": "number"
              }
            }
          }
        },
        "example": {
          "asin": "B00949CTQQ",
          "catalogue": {
            "title": "Classic Eau de Toilette for Men",
            "vpi": "B00949CTQQ",
            "brand": "LaTinte",
            "category": "Facial Peels",
            "parentCategory": "Treatments & Masks",
            "retailPrice": 77.8,
            "imageUrl": "https://m.media-amazon.com/images/I/61dJyrTq+rL.jpg",
            "linkUrl": "https://amazon.com/dp/B00949CTQQ",
            "isFulfilledByAmazon": false
          },
          "orderedRevenue": {
            "glanceViews": 544564,
            "lostFeaturedOffer": 3.42,
            "orderedRevenue": 2119116.4,
            "orderedUnits": 27238,
            "conversionRate": 5,
            "retailPrice": 77.8
          },
          "shippedRevenue": {
            "sourcing": {
              "shippedRevenue": 1288056.8,
              "shippedUnits": 16556,
              "shippedCogs": 113624.42,
              "customerReturns": 178,
              "unitCogs": 6.86,
              "rawMargin": 91.18,
              "netPpm": 51.08
            },
            "manufacturing": {
              "shippedRevenue": 1759836,
              "shippedUnits": 16556,
              "shippedCogs": 225829.52,
              "customerReturns": 178,
              "unitCogs": 13.64,
              "rawMargin": 87.17
            }
          },
          "inventory": {
            "sellableInventory": 258149.67,
            "sellableUnits": 1314,
            "receivedUnits": 95,
            "unitsShipped": 16556,
            "daysCover": 43.7,
            "openPo": 312
          },
          "po": {
            "price": 70.48,
            "poValue": 242197.28,
            "unitsOrdered": 11679,
            "avgPrice": 20.74,
            "daysSinceLastOrder": 12
          },
          "profit": {
            "shippedCogs": 113624.42,
            "chargebacks": 2697.2,
            "expenses": 2697.2,
            "profit": 110927.22,
            "inventory": 1314,
            "snsUnits": 137
          },
          "sourcingShare": {
            "lostCogsUsa": 112205.1,
            "lostUnitsUsa": 6064,
            "sourcingShareUsa": 73.19,
            "unitCogs": 6.86,
            "otherVendors": 18.5
          },
          "advertising": {
            "adSales": 0,
            "spend": 0,
            "acos": 0,
            "roas": 0
          }
        }
      },
      "ConvertTagsRequest": {
        "type": "object",
        "required": ["tag"],
        "properties": {
          "tag": {
            "type": "string",
            "description": "The tag to convert between private and shared scope. Shared tags are prefixed with 'org://'. Must be a non-empty string."
          }
        },
        "example": {
          "tag": "amazon"
        }
      },
      "ConvertTagsResponse": {
        "type": "object",
        "description": "The caller's full tag set across all channels after the conversion.",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "merchantId": {
                  "type": "string",
                  "nullable": true,
                  "description": "Merchant ID of the channel"
                },
                "tags": {
                  "type": "array",
                  "description": "Tags for the channel. Shared tags are prefixed with 'org://'.",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "example": {
          "items": [
            {
              "merchantId": "XXXUS @ ATVPDKIKX0DER",
              "tags": ["org://amazon"]
            },
            {
              "merchantId": "google_demo_001",
              "tags": ["org://amazon"]
            }
          ]
        }
      },
      "GetContentChangesRequest": {
        "type": "object",
        "required": [
          "mid",
          "marketplaceType",
          "marketplaceSubtype",
          "marketplaceCountry",
          "paginationParams"
        ],
        "properties": {
          "mid": {
            "type": "string",
            "description": "Store ID (merchant ID)"
          },
          "marketplaceType": {
            "type": "string",
            "description": "Marketplace type (e.g. amazon, walmart)"
          },
          "marketplaceSubtype": {
            "type": "string",
            "description": "Marketplace subtype (e.g. seller, vendor)"
          },
          "marketplaceCountry": {
            "type": "string",
            "description": "Marketplace country code (e.g. US, GB)"
          },
          "searchText": {
            "type": "string",
            "description": "Search by product identifier, title or product type"
          },
          "differentKeys": {
            "type": "string",
            "description": "Comma-separated list of fields to filter by 'different' status (e.g. 'title,images'). Valid values: title, images, bulletPoints, description, browseNode, productType, relationships"
          },
          "paginationParams": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer",
                "description": "Zero-based page index",
                "default": 0
              },
              "pageSize": {
                "type": "integer",
                "description": "Number of results per page (default 100, max 500)",
                "default": 100,
                "maximum": 500
              },
              "sortKey": {
                "type": "string",
                "description": "Field to sort by",
                "default": "updatedAt"
              },
              "sortOrder": {
                "type": "string",
                "enum": ["asc", "desc"],
                "description": "Sort direction",
                "default": "asc"
              }
            }
          }
        }
      },
      "GetContentChangesResponse": {
        "type": "object",
        "properties": {
          "pageIndex": {
            "type": "integer",
            "description": "Zero-based page index"
          },
          "pageSize": {
            "type": "integer",
            "description": "Number of results per page"
          },
          "totalCount": {
            "type": "integer",
            "description": "Total number of matching products"
          },
          "totalPages": {
            "type": "integer",
            "description": "Total number of pages"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PublicContentChange"
            }
          }
        },
        "example": {
          "pageIndex": 0,
          "pageSize": 100,
          "totalCount": 250,
          "totalPages": 3,
          "items": [
            {
              "productIdentifier": "B08N5WRWNW",
              "titleText": "Example Product Title",
              "marketplace": "amazon",
              "marketplaceSubtype": "amazon",
              "country": "US",
              "storeId": "A1234567890ABC",
              "link": "https://www.amazon.com/dp/B08N5WRWNW",
              "salesRank": 1234,
              "updatedAt": "2026-05-19T10:30:00.000Z",
              "fields": {
                "title": {
                  "status": "different",
                  "original": "Current Product Title",
                  "benchmark": "Example Product Title",
                  "lastDifferentAt": "2026-05-19T08:15:00.000Z"
                },
                "images": {
                  "status": "same",
                  "original": [
                    "https://m.media-amazon.com/images/I/image1.jpg",
                    "https://m.media-amazon.com/images/I/image2.jpg"
                  ],
                  "benchmark": [
                    "https://m.media-amazon.com/images/I/image1.jpg",
                    "https://m.media-amazon.com/images/I/image2.jpg"
                  ],
                  "lastDifferentAt": null
                }
              }
            }
          ]
        }
      },
      "PublicContentChange": {
        "type": "object",
        "properties": {
          "productIdentifier": {
            "type": "string",
            "description": "Product identifier (e.g. ASIN)"
          },
          "titleText": {
            "type": "string",
            "nullable": true,
            "description": "Product title (benchmark value)"
          },
          "marketplace": {
            "type": "string",
            "description": "Marketplace type"
          },
          "marketplaceSubtype": {
            "type": "string",
            "description": "Marketplace subtype"
          },
          "country": {
            "type": "string",
            "description": "Marketplace country code"
          },
          "storeId": {
            "type": "string",
            "description": "Store ID"
          },
          "link": {
            "type": "string",
            "description": "Link to product on marketplace"
          },
          "salesRank": {
            "type": "integer",
            "nullable": true,
            "description": "Product sales rank"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp of last content change check"
          },
          "fields": {
            "type": "object",
            "description": "Per-field change information. Only fields that have been tracked are present.",
            "properties": {
              "title": {
                "$ref": "#/components/schemas/PublicContentField"
              },
              "images": {
                "$ref": "#/components/schemas/PublicContentField"
              },
              "bulletPoints": {
                "$ref": "#/components/schemas/PublicContentField"
              },
              "description": {
                "$ref": "#/components/schemas/PublicContentField"
              },
              "browseNode": {
                "$ref": "#/components/schemas/PublicContentField"
              },
              "productType": {
                "$ref": "#/components/schemas/PublicContentField"
              },
              "relationships": {
                "$ref": "#/components/schemas/PublicContentField"
              }
            }
          }
        }
      },
      "PublicContentField": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": ["same", "different"],
            "description": "Whether the current value differs from the benchmark"
          },
          "original": {
            "description": "Current value on the marketplace (string, array of strings, or relationships object)"
          },
          "benchmark": {
            "description": "User-accepted baseline value"
          },
          "lastDifferentAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Timestamp when this field was last observed as different"
          }
        }
      },
      "GetAllTagsRequest": {
        "type": "object",
        "properties": {
          "paginationParams": {
            "type": "object",
            "properties": {
              "pageIndex": {
                "type": "integer",
                "description": "Zero-based page index",
                "default": 0
              },
              "pageSize": {
                "type": "integer",
                "description": "Number of results per page (default 25, max 100)",
                "default": 25,
                "maximum": 100
              }
            }
          }
        }
      },
      "PublicChannelTags": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string",
            "nullable": true,
            "description": "Channel (store) ID, resolved from the merchant ID where available"
          },
          "merchantId": {
            "type": "string",
            "nullable": true,
            "description": "Merchant ID of the channel"
          },
          "tags": {
            "type": "array",
            "description": "Tags for the channel. Shared tags are prefixed with 'org://'.",
            "items": {
              "type": "string"
            }
          }
        },
        "example": {
          "channelId": "A1234567890ABC",
          "merchantId": "XXXUS @ ATVPDKIKX0DER",
          "tags": ["amazon", "org://ebay"]
        }
      },
      "GetAllTagsResponse": {
        "type": "object",
        "properties": {
          "pageIndex": {
            "type": "integer",
            "description": "Zero-based page index"
          },
          "pageSize": {
            "type": "integer",
            "description": "Number of channels per page"
          },
          "totalCount": {
            "type": "integer",
            "description": "Total number of channels with tags"
          },
          "totalPages": {
            "type": "integer",
            "description": "Total number of pages"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PublicChannelTags"
            }
          }
        },
        "example": {
          "pageIndex": 0,
          "pageSize": 25,
          "totalCount": 2,
          "totalPages": 1,
          "items": [
            {
              "channelId": "A1234567890ABC",
              "merchantId": "XXXUS @ ATVPDKIKX0DER",
              "tags": ["amazon", "org://ebay"]
            },
            {
              "channelId": "google_demo_001",
              "merchantId": "google_demo_001",
              "tags": ["north-america"]
            }
          ]
        }
      },
      "GetChannelTagsRequest": {
        "type": "object",
        "required": ["channelId", "merchantId"],
        "properties": {
          "channelId": {
            "type": "string",
            "description": "Channel (store) ID"
          },
          "merchantId": {
            "type": "string",
            "description": "Merchant ID of the channel"
          }
        }
      },
      "UpdateChannelTagsRequest": {
        "type": "object",
        "required": ["channelId", "merchantId"],
        "properties": {
          "channelId": {
            "type": "string",
            "description": "Channel (store) ID"
          },
          "merchantId": {
            "type": "string",
            "description": "Merchant ID of the channel"
          },
          "addTags": {
            "type": "array",
            "description": "Tags to add to the channel. Non-empty strings only. Shared tags are prefixed with 'org://'.",
            "items": {
              "type": "string"
            }
          },
          "removeTags": {
            "type": "array",
            "description": "Tags to remove from the channel. Non-empty strings only. Tags not present on the channel are ignored.",
            "items": {
              "type": "string"
            }
          }
        },
        "example": {
          "channelId": "A1234567890ABC",
          "merchantId": "XXXUS @ ATVPDKIKX0DER",
          "addTags": ["north-america"],
          "removeTags": ["org://ebay"]
        }
      },
      "CreateReportResponse": {
        "type": "object",
        "properties": {
          "reportId": {
            "type": "string"
          },
          "reportType": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        }
      },
      "Channel": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "marketplace": {
            "type": "string"
          },
          "countryCode": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "hasAdvertisingConnected": {
            "type": "boolean"
          }
        }
      },
      "GetOrdersResponse": {
        "type": "object",
        "properties": {
          "meta": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string",
                "nullable": true,
                "description": "Pass as key to get the next page. null when there are no more orders."
              }
            }
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Order"
            }
          }
        }
      },
      "Order": {
        "type": "object",
        "description": "An Amazon order in the Amazon Orders API 2026-01-01 format. Line items are not included.",
        "properties": {
          "_id": {
            "type": "string",
            "description": "Unique ID of the order record."
          },
          "ApiVersion": {
            "type": "string",
            "example": "2026-01-01",
            "description": "The Amazon Orders API version of the order. Always \"2026-01-01\"."
          },
          "orderId": {
            "type": "string"
          },
          "orderAliases": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "aliasId": {
                  "type": "string"
                },
                "aliasType": {
                  "type": "string",
                  "enum": ["SELLER_ORDER_ID"]
                }
              }
            }
          },
          "createdTime": {
            "type": "string",
            "format": "date-time"
          },
          "lastUpdatedTime": {
            "type": "string",
            "format": "date-time"
          },
          "salesChannel": {
            "type": "object",
            "properties": {
              "channelName": {
                "type": "string",
                "enum": ["AMAZON"]
              },
              "marketplaceId": {
                "type": "string"
              },
              "marketplaceName": {
                "type": "string"
              }
            }
          },
          "proceeds": {
            "type": "object",
            "properties": {
              "grandTotal": {
                "type": "object",
                "properties": {
                  "amount": {
                    "type": "string",
                    "example": "36.0",
                    "description": "Decimal amount as a string."
                  },
                  "currencyCode": {
                    "type": "string"
                  }
                }
              },
              "breakdowns": {
                "type": "array",
                "description": "How grandTotal is made up.",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string"
                    },
                    "subtotal": {
                      "$ref": "#/components/schemas/OrderMoney"
                    }
                  }
                }
              }
            }
          },
          "recipient": {
            "type": "object",
            "description": "PII is not included.",
            "properties": {
              "deliveryAddress": {
                "type": "object",
                "properties": {
                  "city": {
                    "type": "string"
                  },
                  "districtOrCounty": {
                    "type": "string"
                  },
                  "stateOrRegion": {
                    "type": "string"
                  },
                  "municipality": {
                    "type": "string"
                  },
                  "postalCode": {
                    "type": "string"
                  },
                  "countryCode": {
                    "type": "string"
                  },
                  "addressType": {
                    "type": "string",
                    "enum": ["RESIDENTIAL", "COMMERCIAL", "PICKUP_POINT"]
                  }
                }
              },
              "deliveryPreference": {
                "type": "object",
                "properties": {
                  "dropOffLocation": {
                    "type": "string"
                  },
                  "addressInstruction": {
                    "type": "string"
                  },
                  "deliveryTime": {
                    "type": "object",
                    "properties": {
                      "businessHours": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "dayOfWeek": {
                              "type": "string",
                              "enum": ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]
                            },
                            "timeWindows": {
                              "$ref": "#/components/schemas/OrderTimeWindows"
                            }
                          }
                        }
                      },
                      "exceptionDates": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "exceptionDate": {
                              "type": "string",
                              "format": "date"
                            },
                            "exceptionDateType": {
                              "type": "string",
                              "enum": ["CLOSED", "OPEN"]
                            },
                            "timeWindows": {
                              "$ref": "#/components/schemas/OrderTimeWindows"
                            }
                          }
                        }
                      }
                    }
                  },
                  "deliveryCapabilities": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "enum": ["HAS_ACCESS_POINT", "PALLET_ENABLED", "PALLET_DISABLED"]
                    }
                  }
                }
              }
            }
          },
          "fulfillment": {
            "type": "object",
            "properties": {
              "fulfillmentStatus": {
                "type": "string",
                "enum": ["PENDING_AVAILABILITY", "PENDING", "UNSHIPPED", "PARTIALLY_SHIPPED", "SHIPPED", "CANCELLED", "UNFULFILLABLE"]
              },
              "fulfilledBy": {
                "type": "string",
                "enum": ["AMAZON", "MERCHANT"]
              },
              "fulfillmentServiceLevel": {
                "type": "string",
                "enum": ["EXPEDITED", "FREE_ECONOMY", "NEXT_DAY", "PRIORITY", "SAME_DAY", "SECOND_DAY", "SCHEDULED", "STANDARD"]
              },
              "shipByWindow": {
                "$ref": "#/components/schemas/OrderDateTimeRange"
              },
              "deliverByWindow": {
                "$ref": "#/components/schemas/OrderDateTimeRange"
              },
              "labelPrintingWindow": {
                "$ref": "#/components/schemas/OrderDateTimeRange"
              },
              "promiseCalculationInputs": {
                "type": "object",
                "properties": {
                  "transitTime": {
                    "type": "object",
                    "properties": {
                      "details": {
                        "type": "object",
                        "properties": {
                          "carrier": {
                            "type": "string"
                          },
                          "shippingService": {
                            "type": "string"
                          }
                        }
                      },
                      "dataSource": {
                        "type": "string",
                        "enum": ["AMAZON_AUTOMATED", "SELLER_SET", "THIRD_PARTY_INTEGRATOR"]
                      }
                    }
                  }
                }
              }
            }
          },
          "programs": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": ["PREORDER", "PRIME", "PREMIUM", "IN_STORE_PICK_UP", "AMAZON_BUSINESS", "AMAZON_HAUL", "AMAZON_BAZAAR"]
            }
          },
          "associatedOrders": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "orderId": {
                  "type": "string"
                },
                "associationType": {
                  "type": "string",
                  "enum": ["REPLACEMENT_ORIGINAL_ID", "EXCHANGE_ORIGINAL_ID"]
                }
              }
            }
          },
          "packages": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "packageReferenceId": {
                  "type": "string"
                },
                "createdTime": {
                  "type": "string",
                  "format": "date-time"
                },
                "packageStatus": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": ["PENDING", "IN_TRANSIT", "SHIPPED", "DELIVERED", "CANCELLED", "UNDELIVERABLE"]
                    },
                    "detailedStatus": {
                      "type": "string",
                      "enum": ["PENDING_SCHEDULE", "PENDING_PICK_UP", "PENDING_DROP_OFF", "LABEL_CANCELLED", "PICKED_UP", "DROPPED_OFF", "AT_ORIGIN_FC", "AT_DESTINATION_FC", "DELIVERED", "REJECTED_BY_BUYER", "UNDELIVERABLE", "RETURNING_TO_SELLER", "RETURNED_TO_SELLER", "LOST", "OUT_FOR_DELIVERY", "DAMAGED"]
                    }
                  }
                },
                "carrier": {
                  "type": "string"
                },
                "shipTime": {
                  "type": "string",
                  "format": "date-time"
                },
                "shippingService": {
                  "type": "string"
                },
                "trackingNumber": {
                  "type": "string"
                },
                "shipFromAddress": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "addressLine1": {
                      "type": "string"
                    },
                    "addressLine2": {
                      "type": "string"
                    },
                    "addressLine3": {
                      "type": "string"
                    },
                    "city": {
                      "type": "string"
                    },
                    "districtOrCounty": {
                      "type": "string"
                    },
                    "stateOrRegion": {
                      "type": "string"
                    },
                    "municipality": {
                      "type": "string"
                    },
                    "postalCode": {
                      "type": "string"
                    },
                    "countryCode": {
                      "type": "string"
                    }
                  }
                },
                "packageItems": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "orderItemId": {
                        "type": "string"
                      },
                      "quantity": {
                        "type": "integer"
                      },
                      "transparencyCodes": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "OrderMoney": {
        "type": "object",
        "properties": {
          "amount": {
            "type": "string",
            "example": "36.0",
            "description": "Decimal amount as a string."
          },
          "currencyCode": {
            "type": "string"
          }
        }
      },
      "OrderDateTimeRange": {
        "type": "object",
        "properties": {
          "earliestDateTime": {
            "type": "string",
            "format": "date-time"
          },
          "latestDateTime": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "OrderTimeWindows": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "startTime": {
              "$ref": "#/components/schemas/OrderHourMinute"
            },
            "endTime": {
              "$ref": "#/components/schemas/OrderHourMinute"
            }
          }
        }
      },
      "OrderHourMinute": {
        "type": "object",
        "properties": {
          "hour": {
            "type": "integer"
          },
          "minute": {
            "type": "integer"
          }
        }
      },
      "GetOrdersRequest": {
        "type": "object",
        "required": ["channelId", "merchantId"],
        "properties": {
          "channelId": {
            "type": "string",
            "description": "The channel ID, as returned by the channels endpoint"
          },
          "merchantId": {
            "type": "string",
            "description": "The channel's merchant ID, as returned by the channels endpoint"
          },
          "dateField": {
            "type": "string",
            "enum": ["createdAt", "updatedAt"],
            "description": "The field to which fromDate and toDate filter are applied - either 'createdAt' (the order's createdTime) or 'updatedAt' (the order's lastUpdatedTime)"
          },
          "fromDate": {
            "type": "integer",
            "example": 1609459200,
            "description": "Start of date range as unix epoch seconds."
          },
          "toDate": {
            "type": "integer",
            "example": 1612137600,
            "description": "End of date range as unix epoch seconds."
          },
          "orderId": {
            "type": "string",
            "description": "The order ID to filter by"
          },
          "key": {
            "type": "string",
            "description": "The key used for pagination - pass meta.key from the previous response to get the next page"
          },
          "pageSize": {
            "type": "integer",
            "example": 50,
            "description": "The number of results to return per page (Default 10, Max 100)"
          }
        }
      },
      "GetChannelsRequest": {
        "type": "object",
        "properties": {
          "filter": {
            "type": "object",
            "properties": {
              "marketplaces": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "countryCodes": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "ReportStatus": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CreateReportResponse"
          },
          {
            "type": "object",
            "properties": {
              "downloadUrl": {
                "type": "string"
              }
            }
          }
        ]
      },
      "CommonReportOptions": {
        "type": "object",
        "properties": {
          "fromDate": {
            "type": "number",
            "description": "Unix epoch time (seconds) representing the start of the reporting period"
          },
          "toDate": {
            "type": "number",
            "description": "Unix epoch time (seconds) representing the end of the reporting period"
          },
          "priorFromDate": {
            "type": "number",
            "description": "Unix epoch time (seconds) representing the start of the comparison period"
          },
          "priorToDate": {
            "type": "number",
            "description": "Unix epoch time (seconds) representing the end of the comparison period"
          },
          "timezone": {
            "type": "string",
            "description": "The timezone string you wish to see the report in (e.g. 'America/Los_Angeles') see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"
          }
        }
      },
      "CreateSalesByProductReportOptions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          },
          {
            "type": "object",
            "properties": {
              "includeNoSales": {
                "type": "boolean",
                "description": "Whether products with no sales should be included in the report"
              },
              "includeNoInventory": {
                "type": "boolean",
                "description": "Whether products with zero inventory should be included in the report"
              },
              "includeTax": {
                "type": "boolean",
                "description": "Whether tax should be included in sales figures"
              }
            }
          }
        ]
      },
      "CreateChannelProfitAndLossReportOptions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          },
          {
            "type": "object",
            "properties": {
              "includeTax": {
                "type": "boolean",
                "description": "Whether tax should be included in sales figures"
              },
              "profitabilityView": {
                "type": "string",
                "enum": ["settled", "accrual"],
                "description": "Accounting basis for the P&L. 'settled' (default) is cash-basis; 'accrual' recognises revenue and costs when earned or incurred, before settlement. Defaults to 'settled' when omitted."
              },
              "includeCogsRefunds": {
                "type": "boolean",
                "default": false,
                "description": "If true, the cost of goods for refunded items (RefundCOGS) is deducted from the Cancellations & Refunds expense total in the P&L. Amazon sellers only - ignored for other marketplaces. Defaults to false."
              }
            }
          }
        ]
      },
      "CreateSalesByProductReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CreateSalesByProductReportOptions"
          }
        }
      },
      "CreateClientReportRequest": {
        "type": "object",
        "properties": {
          "reportId": {
            "type": "string",
            "description": "The reportId of the Client Report, as returned by the GET /clientReports listing endpoint"
          }
        },
        "required": ["reportId"]
      },
      "ClientReportCreateResponse": {
        "type": "object",
        "properties": {
          "reportId": {
            "type": "string",
            "description": "The Client Report's own ID, echoed back from the request"
          },
          "jobId": {
            "type": "string",
            "description": "The PDF generation job's ID - use this with GET /clientReports/generatePDF?jobId={jobId} to poll for completion"
          },
          "status": {
            "type": "string",
            "enum": [
              "started",
              "inProgress",
              "done"
            ],
            "description": "\"started\" for a newly-created job. \"started\" / \"inProgress\" with an existing jobId if a PDF of this report you requested is still being generated - poll that job. \"done\" if you already created a PDF of this report within the last 60 minutes and it was returned instead (see downloadUrl/generatedAt)"
          },
          "downloadUrl": {
            "type": "string",
            "description": "Only present when status is \"done\" (an existing PDF was reused)"
          },
          "downloadUrlExpiresAt": {
            "type": "string",
            "description": "Only present when status is \"done\" - when downloadUrl stops working"
          },
          "generatedAt": {
            "type": "string",
            "description": "Only present when status is \"done\" (an existing PDF was reused) - when that PDF was originally generated"
          }
        }
      },
      "ClientReportStatus": {
        "type": "object",
        "properties": {
          "reportId": {
            "type": "string"
          },
          "jobId": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "started",
              "inProgress",
              "done",
              "errored"
            ],
            "description": "\"started\" / \"inProgress\" while the PDF is being generated - keep polling. \"done\" when downloadUrl is ready. \"errored\" if generation failed (see errorReason) - request a new PDF to try again"
          },
          "downloadUrl": {
            "type": "string",
            "description": "Only present when status is \"done\""
          },
          "downloadUrlExpiresAt": {
            "type": "string",
            "description": "Only present when status is \"done\" - when downloadUrl stops working"
          },
          "generatedAt": {
            "type": "string",
            "description": "Only present when status is \"done\" - when the PDF was generated"
          },
          "errorReason": {
            "type": "string",
            "description": "Only present when status is \"errored\" - why the PDF could not be generated (see the response examples)",
            "example": "The report could not be displayed - it may have been deleted or is not available"
          }
        }
      },
      "GetStoreProfitLossReportOptions": {
        "type": "object",
        "properties": {
          "fromDate": {
            "type": "integer",
            "description": "Unix epoch time (seconds) representing the start of the reporting period"
          },
          "toDate": {
            "type": "integer",
            "description": "Unix epoch time (seconds) representing the end of the reporting period"
          },
          "timezone": {
            "type": "string"
          },
          "includeTax": {
            "type": "boolean"
          },
          "profitabilityView": {
            "type": "string",
            "enum": ["settled", "accrual"],
            "description": "Accounting basis for the P&L. 'settled' (default) is cash-basis; 'accrual' recognises revenue and costs when earned or incurred, before settlement. Defaults to 'settled' when omitted."
          },
          "includeCogsRefunds": {
            "type": "boolean",
            "default": false,
            "description": "If true, the cost of goods for refunded items (RefundCOGS) is deducted from the Cancellations & Refunds expense total in the P&L. Amazon sellers only - ignored for other marketplaces. Defaults to false."
          }
        },
        "required": ["fromDate", "toDate", "includeTax", "timezone"]
      },
      "CreateProductsReportOptions": {
        "type": "object",
        "properties": {
          "skus": {
            "type": "string",
            "description": "(Optional) A comma-separated list of SKUs to filter by"
          }
        }
      },
      "GetProductProfitLossReportOptions": {
        "type": "object",
        "properties": {
          "fromDate": {
            "type": "integer",
            "description": "Unix epoch time (seconds) representing the start of the reporting period"
          },
          "toDate": {
            "type": "integer",
            "description": "Unix epoch time (seconds) representing the end of the reporting period"
          },
          "includeTax": {
            "type": "boolean",
            "description": "Whether to include tax in the report"
          },
          "sellerSkus": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The list of skus to filter by, max 50"
          },
          "pageSize": {
            "type": "integer",
            "description": "The size of the current page, max 50"
          },
          "pageIndex": {
            "type": "integer",
            "description": "The index of the current page"
          },
          "profitabilityView": {
            "type": "string",
            "enum": ["settled", "accrual"],
            "description": "Accounting basis for the P&L. 'settled' (default) is cash-basis; 'accrual' recognises revenue and costs when earned or incurred, before settlement. Defaults to 'settled' when omitted."
          },
          "includeCogsRefunds": {
            "type": "boolean",
            "default": false,
            "description": "If true, the cost of goods for refunded items (RefundCOGS) is deducted from the Cancellations & Refunds expense total in the P&L. Amazon sellers only - ignored for other marketplaces. Defaults to false."
          }
        },
        "required": ["fromDate", "toDate", "includeTax"]
      },
      "CreateShippedRevenueReportOptions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          },
          {
            "type": "object",
            "properties": {
              "view": {
                "type": "string",
                "enum": ["sourcing", "manufacturing"],
                "description": "The level at which you wish to view revenue metrics - either 'sourcing' or 'manufacturing'"
              }
            }
          }
        ]
      },
      "CreateTrafficAndConversionReportOptions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          },
          {
            "type": "object",
            "properties": {
              "view": {
                "type": "string",
                "enum": ["parents", "skus"],
                "description": "The level at which you wish to view product metrics - either 'parents' or 'skus'"
              }
            }
          }
        ]
      },
      "CreateCustomerLifetimeValueReportOptions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          }
        ]
      },
      "CreateCancellationsAndRefundsReportOptions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          },
          {
            "type": "object",
            "properties": {
              "includeTax": {
                "type": "boolean",
                "description": "Whether tax should be included in sales figures"
              }
            }
          }
        ]
      },
      "CreateRepeatPurchaseReportOptions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          },
          {
            "type": "object",
            "properties": {
              "includeTax": {
                "type": "boolean",
                "description": "Whether tax should be included in sales figures"
              }
            }
          }
        ]
      },
      "CreateMarketingByProductReportOptions": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "fromDate": {
                "type": "integer",
                "description": "Unix epoch time (seconds) representing the start of the reporting period"
              },
              "toDate": {
                "type": "integer",
                "description": "Unix epoch time (seconds) representing the end of the reporting period"
              },
              "timezone": {
                "type": "string",
                "description": "The timezone string you wish to see the report in (e.g. 'America/Los_Angeles') see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"
              }
            }
          }
        ]
      },
      "CreateSubscribeAndSaveReportOptions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          },
          {
            "type": "object",
            "properties": {
              "includeTax": {
                "type": "boolean",
                "description": "Whether tax should be included in sales figures"
              }
            }
          }
        ]
      },
      "GetAdvertisingByChannelsRequest": {
        "type": "object",
        "properties": {
          "reportOptions": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CommonReportOptions"
              },
              {
                "type": "object",
                "required": [
                  "fromDate",
                  "toDate",
                  "priorFromDate",
                  "priorToDate",
                  "timezone"
                ]
              }
            ],
            "description": "Common reporting options that determine the reporting and comparison ranges",
            "example": {
              "fromDate": 1711843200,
              "toDate": 1714448800,
              "priorFromDate": 1711843200,
              "priorToDate": 1714448800,
              "timezone": "America/Los_Angeles"
            }
          },
          "includeTax": {
            "type": "boolean",
            "description": "Whether tax should be included in sales figures",
            "example": false
          },
          "vendorRevenueType": {
            "type": "string",
            "enum": ["orderedRevenue", "shippedRevenue"],
            "description": "Determine whether the revenue type of a vendor should be retrieved by ordered or shipped revenue",
            "example": "orderedRevenue"
          },
          "currentCurrency": {
            "type": "string",
            "description": "3-letter currency code for the current view (e.g. USD, AUD). Used for exchange conversion.",
            "example": "USD"
          },
          "orderBy": {
            "type": "string",
            "description": "The field to sort by (defaults to 'impressions')",
            "example": "impressions"
          },
          "pageIndex": {
            "type": "integer",
            "description": "Zero-based page index (defaults to 0)",
            "example": 0
          },
          "pageSize": {
            "type": "integer",
            "description": "The number of results to return per page (max 100) (defaults to 10)",
            "example": 10
          },
          "filter": {
            "type": "object",
            "description": "Optional filters applied when selecting stores to include in the report",
            "properties": {
              "marketplaces": {
                "type": "array",
                "description": "Marketplace identifiers to include (e.g. 'amazon', 'ebay')",
                "items": {
                  "type": "string"
                }
              },
              "countries": {
                "type": "array",
                "description": "ISO 3166-1 alpha-2 country codes to include",
                "items": {
                  "type": "string"
                }
              },
              "tags": {
                "type": "array",
                "description": "Store tags to include",
                "items": {
                  "type": "string"
                }
              }
            }
          },
          "searchText": {
            "type": "string",
            "description": "Optional text to match store names or marketplace identifiers when selecting stores",
            "example": "Amazon US"
          }
        },
        "required": ["reportOptions", "currentCurrency"],
        "description": "Criteria to view advertising performance by channel"
      },
      "AdvertisingByChannelsItem": {
        "type": "object",
        "properties": {
          "store": {
            "type": "string",
            "description": "Store display name"
          },
          "countryCode": {
            "type": "string",
            "description": "Marketplace country code"
          },
          "adsales": {
            "type": "string",
            "description": "Attributed advertising sales"
          },
          "priorAdsales": {
            "type": "string",
            "description": "Attributed advertising sales (comparison period)"
          },
          "spend": {
            "type": "string",
            "description": "Advertising spend"
          },
          "priorSpend": {
            "type": "string",
            "description": "Advertising spend (comparison period)"
          },
          "acos": {
            "type": "string",
            "description": "Advertising cost of sales (%)"
          },
          "priorAcos": {
            "type": "string",
            "description": "Advertising cost of sales (%) (comparison period)"
          },
          "roas": {
            "type": "string",
            "description": "Return on ad spend"
          },
          "priorRoas": {
            "type": "string",
            "description": "Return on ad spend (comparison period)"
          },
          "tacos": {
            "type": "string",
            "description": "Total advertising cost of sales (%)"
          },
          "priorTacos": {
            "type": "string",
            "description": "Total advertising cost of sales (%) (comparison period)"
          },
          "troas": {
            "type": "string",
            "description": "Total return on ad spend"
          },
          "priorTroas": {
            "type": "string",
            "description": "Total return on ad spend (comparison period)"
          },
          "impressions": {
            "type": "number"
          },
          "clicks": {
            "type": "number"
          },
          "ctr": {
            "type": "string",
            "description": "Click-through rate (%)"
          },
          "cpc": {
            "type": "string",
            "description": "Cost per click"
          },
          "conv": {
            "type": "string",
            "description": "Conversion rate (%)"
          },
          "orders": {
            "type": "number"
          },
          "units": {
            "type": "number"
          },
          "NTB_sales": {
            "type": "string",
            "description": "New-to-brand attributed sales"
          },
          "percentage_sales_NTB": {
            "type": "string",
            "description": "Percentage of sales from new-to-brand customers (%)"
          },
          "NTB_orders": {
            "type": "number"
          },
          "percentage_orders_NTB": {
            "type": "string"
          },
          "NTB_units": {
            "type": "number"
          },
          "percentage_units_NTB": {
            "type": "string"
          },
          "marketplace_id": {
            "type": "string"
          },
          "seller_id": {
            "type": "string"
          },
          "attributed_units_ordered_same_sku": {
            "type": "number"
          }
        },
        "description": "One row of advertising performance metrics for a store/channel"
      },
      "GetAdvertisingByChannelsResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": ["success", "error"]
          },
          "data": {
            "type": "object",
            "properties": {
              "items": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AdvertisingByChannelsItem"
                }
              },
              "pageIndex": {
                "type": "integer"
              },
              "pageSize": {
                "type": "integer"
              },
              "totalItems": {
                "type": "integer"
              },
              "totalPages": {
                "type": "integer"
              }
            }
          },
          "error": {
            "type": "string"
          }
        },
        "description": "Paginated advertising performance by channel",
        "example": {
          "status": "success",
          "data": {
            "items": [
              {
                "store": "Acme AU",
                "countryCode": "AUS",
                "adsales": "1200.25",
                "priorAdsales": "-",
                "spend": "300.10",
                "priorSpend": "-",
                "acos": "25.01",
                "priorAcos": "-",
                "roas": "3.99",
                "priorRoas": "-",
                "tacos": "5.00",
                "priorTacos": "-",
                "troas": "20.00",
                "priorTroas": "-",
                "impressions": 200000,
                "clicks": 5200,
                "ctr": "2.60",
                "cpc": "0.58",
                "conv": "3.40",
                "orders": 176,
                "units": 220,
                "NTB_sales": "400.00",
                "pecentage_sales_NTB": "33.33",
                "NTB_orders": 60,
                "percentage_orders_NTB": "34.09",
                "NTB_units": 70,
                "percentage_units_NTB": "31.82",
                "marketplace_id": "AUS-MKT",
                "seller_id": "SELLER-123",
                "attributed_units_ordered_same_sku": 50
              }
            ],
            "pageIndex": 0,
            "pageSize": 10,
            "totalItems": 1,
            "totalPages": 1
          }
        }
      },
      "GetProductProfitAndLossRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "type": "object",
            "$ref": "#/components/schemas/GetProductProfitLossReportOptions"
          }
        },
        "required": ["channelId", "merchantId", "reportOptions"],
        "description": "Request a single or multiple products profit and loss details."
      },
      "GetProductProfitAndLossResponse": {
        "type": "object",
        "properties": {
          "productEvents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "sellerSku": {
                  "type": "string"
                },
                "productSku": {
                  "type": "string"
                },
                "title": {
                  "type": "string"
                },
                "totalRevenue": {
                  "type": "number"
                },
                "totalExpenses": {
                  "type": "number"
                },
                "totalProfit": {
                  "type": "number"
                },
                "sales": {
                  "type": "number"
                },
                "advertisingSpend": {
                  "type": "number"
                },
                "sellingFees": {
                  "type": "number"
                },
                "shippingFees": {
                  "type": "number"
                },
                "refunds": {
                  "type": "number"
                },
                "reimbursements": {
                  "type": "number"
                },
                "otherIncome": {
                  "type": "number"
                },
                "promotions": {
                  "type": "number"
                },
                "refundsAndReturnsOverheads": {
                  "type": "number"
                },
                "cogs": {
                  "type": "number"
                },
                "otherExpenses": {
                  "type": "number"
                }
              }
            }
          },
          "count": {
            "type": "number"
          }
        },
        "description": "Response for single or multiple products profit and loss details"
      },
      "UpdateDirectCostsRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "fromDate": {
            "type": "integer",
            "example": 1609459200,
            "description": "Unix epoch time (seconds) representing the effective from date"
          },
          "directCosts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "sellerSku": {
                  "type": "string"
                },
                "cogs": {
                  "type": "number"
                },
                "cogsCurrency": {
                  "type": "string",
                  "description": "Valid 3 letter currency code, e.g. USD, AUD, etc"
                },
                "shippingCost": {
                  "type": "number",
                  "description": "(Optional)"
                },
                "shippingCostCurrency": {
                  "type": "string",
                  "description": "(Optional) Valid 3 letter currency code, e.g. USD, AUD, etc"
                }
              }
            }
          }
        },
        "required": ["channelId", "merchantId", "fromDate", "directCosts"],
        "description": "Input data for request to update the Unit COGS"
      },
      "UpdateDirectCostsResponse": {
        "type": "object",
        "properties": {
          "jobId": {
            "type": "string"
          }
        },
        "description": "Response for request to update the Unit COGS"
      },
      "PatchGroupRequest": {
        "type": "object",
        "required": ["channelId", "merchantId"],
        "description": "At least one of groupName, addProducts, removeProducts, addBrands, or removeBrands must be provided. Use addProducts/removeProducts only for product-based groups, and addBrands/removeBrands only for brand-based groups — these cannot be mixed in the same request.",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "groupName": {
            "type": "string"
          },
          "addProducts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "sellerSku": {
                  "type": "string",
                  "description": "The seller SKU of the product"
                }
              }
            }
          },
          "removeProducts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "sellerSku": {
                  "type": "string",
                  "description": "The seller SKU of the product"
                }
              }
            }
          },
          "addBrands": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "removeBrands": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "CreateCustomGroupRequest": {
        "type": "object",
        "required": ["channelId", "merchantId", "groupName"],
        "description": "Either products or brands must be provided (not both)",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "groupName": {
            "type": "string"
          },
          "products": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "sellerSku": {
                  "type": "string",
                  "description": "The seller SKU of the product"
                }
              }
            }
          },
          "brands": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "groupId": {
            "type": "string",
            "description": "Optional. The ID of an existing custom group, as returned by the GET custom groups endpoint. Providing this value will completely overwrite the existing group. To add or remove individual items instead, use the PATCH endpoint."
          }
        }
      },
      "CreateCustomGroupResponse": {
        "type": "object",
        "description": "Response containing the ID of the created custom group",
        "properties": {
          "groupId": {
            "type": "integer"
          }
        }
      },
      "GetCustomGroupResponse": {
        "type": "object",
        "description": "A single custom group with its associated products and brands",
        "properties": {
          "group": {
            "type": "object",
            "properties": {
              "groupId": {
                "type": "integer"
              },
              "groupName": {
                "type": "string"
              },
              "products": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "sellerSku": {
                      "type": "string",
                      "description": "The seller SKU of the product"
                    }
                  }
                }
              },
              "brands": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "GetCustomGroupsResponse": {
        "type": "object",
        "description": "Response containing the list of custom product groups for a channel",
        "properties": {
          "groups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "groupId": {
                  "type": "integer"
                },
                "groupName": {
                  "type": "string"
                }
              }
            }
          },
          "total": {
            "type": "integer",
            "description": "Total number of groups for the channel. Only present when limit or offset is provided."
          }
        }
      },
      "DirectCostJobStatus": {
        "type": "object",
        "properties": {
          "jobStatus": {
            "type": "string",
            "enum": ["COMPLETED", "FAILED", "IN_PROGRESS"]
          }
        },
        "description": "Response for status of a Unit COGS update job"
      },
      "CreateTrafficAndConversionReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CreateTrafficAndConversionReportOptions"
          }
        }
      },
      "CreateCustomerLifetimeValueReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CreateCustomerLifetimeValueReportOptions"
          }
        }
      },
      "CreateCancellationsAndRefundsReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CreateCancellationsAndRefundsReportOptions"
          }
        }
      },
      "CreateRepeatPurchaseReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CreateRepeatPurchaseReportOptions"
          }
        }
      },
      "CreateSuppressedProductReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          }
        }
      },
      "CreateMarketingByProductReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CreateMarketingByProductReportOptions"
          }
        }
      },
      "CreateSubscribeAndSaveReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CreateSubscribeAndSaveReportOptions"
          }
        }
      },
      "CreateShippedRevenueReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CreateShippedRevenueReportOptions"
          }
        }
      },
      "CreateOrderedRevenueReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CommonReportOptions"
          }
        }
      },
      "CreateInventoryHealthReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CommonReportOptions"
          }
        }
      },
      "CreateCampaignsReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CommonReportOptions"
          }
        }
      },
      "CreateInventoryReplenishmentReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          }
        }
      },
      "ArrayOfChannel": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/Channel"
        }
      },
      "CreateChannelProfitAndLossReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CreateChannelProfitAndLossReportOptions"
          }
        }
      },
      "CreateAmazonBuyBoxPerformanceReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "filter": {
            "type": "string",
            "enum": [
              "winning",
              "losing",
              "notParticipating",
              "noOffers",
              "losingToAmazon",
              "losingToOthers",
              "losingToSelf",
              "noWinner"
            ],
            "description": "The type of buy box performance to report on"
          }
        }
      },
      "GetStoreProfitAndLossRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/GetStoreProfitLossReportOptions"
          }
        },
        "required": ["channelId", "merchantId", "reportOptions"],
        "description": "Fetch a store's profit and loss in raw json"
      },
      "CreateProductsReportRequest": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "reportOptions": {
            "$ref": "#/components/schemas/CreateProductsReportOptions"
          }
        }
      },
      "GetStoreProfitAndLossResponse": {
        "type": "object",
        "properties": {
          "totalRevenue": {
            "type": "number"
          },
          "totalExpenses": {
            "type": "number"
          },
          "sales": {
            "type": "number"
          },
          "advertisingSpend": {
            "type": "number"
          },
          "sellingFees": {
            "type": "number"
          },
          "shippingFees": {
            "type": "number"
          },
          "refunds": {
            "type": "number"
          },
          "reimbursements": {
            "type": "number"
          },
          "otherIncome": {
            "type": "number"
          },
          "promotions": {
            "type": "number"
          },
          "refundsAndReturnsOverheads": {
            "type": "number"
          },
          "cogs": {
            "type": "number"
          },
          "otherExpenses": {
            "type": "number"
          }
        },
        "description": "Fetch a store's profit and loss in raw json"
      },
      "SalesByPeriodRequest": {
        "type": "object",
        "description": "Payload used to request the sales-by-period view report.",
        "properties": {
          "merchantId": {
            "type": "string",
            "description": "MerchantSpring merchant identifier for the account whose performance should be returned."
          },
          "channelId": {
            "type": "string",
            "description": "MerchantSpring channel identifier for the account whose performance should be returned."
          },
          "reportOptions": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SalesByPeriodReportOptions"
              }
            ],
            "description": "Defines the reporting window and comparison period that should be analysed."
          },
          "includeTax": {
            "type": "boolean",
            "description": "True by default. When true, gross sales figures include tax; when false, results are reported net of tax."
          },
          "sellerSkus": {
            "type": "array",
            "description": "Optional list of seller SKUs to restrict the dataset to specific products.",
            "items": {
              "type": "string"
            }
          }
        },
        "required": ["merchantId", "channelId", "reportOptions"]
      },
      "VendorSalesByPeriodRequest": {
        "type": "object",
        "description": "Payload used to request the vendor sales-by-period view report.",
        "properties": {
          "merchantId": {
            "type": "string",
            "description": "MerchantSpring merchant identifier for the account whose performance should be returned."
          },
          "channelId": {
            "type": "string",
            "description": "MerchantSpring channel identifier for the account whose performance should be returned."
          },
          "reportOptions": {
            "allOf": [
              {
                "$ref": "#/components/schemas/VendorSalesByPeriodReportOptions"
              }
            ],
            "description": "Defines the reporting window and comparison period that should be analysed."
          },
          "asins": {
            "type": "array",
            "description": "Optional list of ASINs to restrict the dataset to specific products.",
            "items": {
              "type": "string"
            }
          }
        },
        "required": ["merchantId", "channelId", "reportOptions"]
      },
      "VendorSalesByPeriodReportOptions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          },
          {
            "type": "object",
            "description": "Defines the principal and comparison date windows for the report and how results should be bucketed.",
            "properties": {
              "interval": {
                "type": "string",
                "enum": ["y", "Q", "M", "w", "d", "h"],
                "description": "Interval code that controls how results are bucketed (y=year, Q=quarter, M=month, w=week, d=day, h=hour)."
              }
            },
            "required": [
              "fromDate",
              "toDate",
              "priorFromDate",
              "priorToDate",
              "timezone",
              "interval"
            ]
          }
        ]
      },
      "SalesByPeriodReportOptions": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          },
          {
            "type": "object",
            "description": "Defines the principal and comparison date windows for the report and how results should be bucketed.",
            "properties": {
              "interval": {
                "type": "string",
                "enum": ["y", "Q", "M", "w", "d", "h"],
                "description": "Interval code that controls how results are bucketed (y=year, Q=quarter, M=month, w=week, d=day, h=hour)."
              }
            },
            "required": [
              "fromDate",
              "toDate",
              "priorFromDate",
              "priorToDate",
              "timezone",
              "interval"
            ]
          }
        ]
      },
      "SalesByPeriodPerformanceSnapshot": {
        "type": "object",
        "description": "Raw metrics returned by the marketplace service for a single time bucket.",
        "properties": {
          "startTime": {
            "type": "integer",
            "format": "int64",
            "description": "Unix epoch seconds at which this time bucket begins."
          },
          "endTime": {
            "type": "integer",
            "format": "int64",
            "description": "Unix epoch seconds at which this time bucket ends."
          },
          "sales": {
            "type": "number",
            "format": "double",
            "description": "Gross merchandise value for the period in the marketplace's native currency."
          },
          "lineItemCount": {
            "type": "integer",
            "format": "int32",
            "description": "Number of order line items captured during the period."
          },
          "unitsSold": {
            "type": "integer",
            "format": "int32",
            "description": "Total units sold during the period."
          },
          "avgLineItemValue": {
            "type": "number",
            "format": "double",
            "description": "Average value per order line item in the marketplace's native currency."
          },
          "pageViews": {
            "type": "integer",
            "format": "int32",
            "description": "Number of product detail page views recorded."
          },
          "unitsPerView": {
            "type": "number",
            "format": "double",
            "description": "Units sold divided by page views for the period."
          },
          "totalSessions": {
            "type": "integer",
            "format": "int32",
            "description": "Number of unique shopping sessions captured."
          },
          "unitsPerSession": {
            "type": "number",
            "format": "double",
            "description": "Units sold divided by total sessions for the period."
          },
          "buyboxWinPercentage": {
            "type": "number",
            "format": "double",
            "description": "Percentage of page views where the merchant won the Buy Box."
          },
          "adSpend": {
            "type": "number",
            "format": "double",
            "description": "Advertising spend recorded during the period in the marketplace's native currency."
          },
          "adSales": {
            "type": "number",
            "format": "double",
            "description": "Attributed ad-driven sales for the period in the marketplace's native currency."
          },
          "impressions": {
            "type": "integer",
            "format": "int32",
            "description": "Number of ad impressions served during the period."
          },
          "clickThroughRate": {
            "type": "number",
            "format": "double",
            "description": "Ratio of ad clicks to impressions (%)."
          },
          "acos": {
            "type": "number",
            "format": "double",
            "description": "Advertising cost of sales (%)."
          },
          "tacos": {
            "type": "number",
            "format": "double",
            "description": "Total advertising cost of sales (%)."
          }
        }
      },
      "FormattedSalesByPeriodChartData": {
        "type": "object",
        "description": "Human-readable metrics pre-formatted using the requested currency and timezone.",
        "properties": {
          "startTime": {
            "type": "string",
            "description": "Formatted start timestamp for the time bucket (respecting the requested interval and timezone)."
          },
          "endTime": {
            "type": "string",
            "description": "Formatted end timestamp for the time bucket (respecting the requested interval and timezone)."
          },
          "sales": {
            "type": "string",
            "description": "Current-period gross merchandise value formatted in the requested currency."
          },
          "priorSales": {
            "type": "string",
            "description": "Prior-period gross merchandise value formatted in the requested currency."
          },
          "unitsSold": {
            "type": "integer",
            "format": "int32",
            "description": "Units sold during the current period."
          },
          "priorUnitsSold": {
            "type": "integer",
            "format": "int32",
            "description": "Units sold during the comparison period."
          },
          "lineItemCount": {
            "type": "integer",
            "format": "int32",
            "description": "Order line items recorded in the current period."
          },
          "priorLineItemCount": {
            "type": "integer",
            "format": "int32",
            "description": "Order line items recorded in the comparison period."
          },
          "avgLineItemValue": {
            "type": "string",
            "description": "Average value per order line item in the current period, formatted in the requested currency."
          },
          "priorAvgLineItemValue": {
            "type": "string",
            "description": "Average value per order line item in the comparison period, formatted in the requested currency."
          },
          "pageViews": {
            "type": "integer",
            "format": "int32",
            "description": "Product detail page views during the current period."
          },
          "priorPageViews": {
            "type": "integer",
            "format": "int32",
            "description": "Product detail page views during the comparison period."
          },
          "pageViewsConversions": {
            "type": "string",
            "description": "Current-period units per view ratio."
          },
          "priorPageViewsConversions": {
            "type": "string",
            "description": "Comparison-period units per view ratio."
          },
          "totalSessions": {
            "type": "integer",
            "format": "int32",
            "description": "Shopping sessions during the current period."
          },
          "priorTotalSessions": {
            "type": "integer",
            "format": "int32",
            "description": "Shopping sessions during the comparison period."
          },
          "sessionConversions": {
            "type": "string",
            "description": "Current-period units per session ratio."
          },
          "priorSessionConversions": {
            "type": "string",
            "description": "Comparison-period units per session ratio."
          },
          "buyboxWinPercentage": {
            "type": "string",
            "description": "Current-period Buy Box win rate."
          },
          "priorBuyboxWinPercentage": {
            "type": "string",
            "description": "Comparison-period Buy Box win rate."
          },
          "adSpend": {
            "type": "string",
            "description": "Current-period advertising spend formatted in the requested currency."
          },
          "priorAdSpend": {
            "type": "string",
            "description": "Comparison-period advertising spend formatted in the requested currency."
          },
          "adSales": {
            "type": "string",
            "description": "Current-period attributed ad sales formatted in the requested currency."
          },
          "priorAdSales": {
            "type": "string",
            "description": "Comparison-period attributed ad sales formatted in the requested currency."
          },
          "impressions": {
            "type": "integer",
            "format": "int32",
            "description": "Advertising impressions served during the current period."
          },
          "priorImpressions": {
            "type": "integer",
            "format": "int32",
            "description": "Advertising impressions served during the comparison period."
          },
          "clicks": {
            "type": "integer",
            "format": "int32",
            "description": "Advertising clicks recorded during the current period."
          },
          "priorClicks": {
            "type": "integer",
            "format": "int32",
            "description": "Advertising clicks recorded during the comparison period."
          },
          "clickThroughRate": {
            "type": "string",
            "description": "Current-period ad click-through rate."
          },
          "priorClickThroughRate": {
            "type": "string",
            "description": "Comparison-period ad click-through rate."
          },
          "acos": {
            "type": "string",
            "description": "Current-period advertising cost of sales."
          },
          "priorAcos": {
            "type": "string",
            "description": "Comparison-period advertising cost of sales."
          },
          "tacos": {
            "type": "string",
            "description": "Current-period total advertising cost of sales."
          },
          "priorTacos": {
            "type": "string",
            "description": "Comparison-period total advertising cost of sales."
          },
          "currency": {
            "type": "string",
            "description": "Currency code used when formatting the monetary totals."
          }
        }
      },
      "VendorFormattedSalesByPeriodChartData": {
        "type": "object",
        "description": "Human-readable metrics pre-formatted using the requested currency and timezone.",
        "properties": {
          "startTime": {
            "type": "string",
            "description": "Formatted start timestamp for the time bucket (respecting the requested interval and timezone)."
          },
          "endTime": {
            "type": "string",
            "description": "Formatted end timestamp for the time bucket (respecting the requested interval and timezone)."
          },
          "glanceViews": {
            "type": "integer",
            "format": "int32",
            "description": "Current-period glance views"
          },
          "priorGlanceViews": {
            "type": "integer",
            "format": "int32",
            "description": "Prior-period glance views"
          },
          "orderedRevenue": {
            "type": "string",
            "description": "Ordered revenue during the current period."
          },
          "priorOrderedRevenue": {
            "type": "string",
            "description": "Ordered revenue during the comparison period."
          },
          "orderedUnits": {
            "type": "integer",
            "format": "int32",
            "description": "Ordered units during the current period."
          },
          "priorOrderedUnits": {
            "type": "integer",
            "format": "int32",
            "description": "Ordered units during the comparison period."
          },
          "conversionRate": {
            "type": "string",
            "description": "Conversion rate during the current period."
          },
          "priorConversionRate": {
            "type": "string",
            "description": "Conversion rate during the comparison period."
          },
          "retailPrice": {
            "type": "string",
            "description": "Retail price during the current period."
          },
          "priorRetailPrice": {
            "type": "string",
            "description": "Retail price during the comparison period."
          },
          "shippedRevenue": {
            "type": "string",
            "description": "Shipped revenue during the current period."
          },
          "priorShippedRevenue": {
            "type": "string",
            "description": "Shipped revenue during the comparison period."
          },
          "shippedRevenueManufacturing": {
            "type": "string",
            "description": "Shipped revenue manufacturing during the current period."
          },
          "priorShippedRevenueManufacturing": {
            "type": "string",
            "description": "Shipped revenue manufacturing during the comparison period."
          },
          "shippedCogs": {
            "type": "string",
            "description": "Shipped COGS during the current period."
          },
          "priorShippedCogs": {
            "type": "string",
            "description": "Shipped COGS during the comparison period."
          },
          "shippedCogsManufacturing": {
            "type": "string",
            "description": "Shipped COGS manufacturing during the current period."
          },
          "priorShippedCogsManufacturing": {
            "type": "string",
            "description": "Shipped COGS manufacturing during the comparison period."
          },
          "shippedUnits": {
            "type": "integer",
            "format": "int32",
            "description": "Shipped units during the current period."
          },
          "priorShippedUnits": {
            "type": "integer",
            "format": "int32",
            "description": "Shipped units during the comparison period."
          },
          "shippedUnitsManufacturing": {
            "type": "integer",
            "format": "int32",
            "description": "Shipped units manufacturing during the current period."
          },
          "priorShippedUnitsManufacturing": {
            "type": "integer",
            "format": "int32",
            "description": "Shipped units manufacturing during the comparison period."
          },
          "adSales": {
            "type": "string",
            "description": "Ad sales during the current period."
          },
          "priorAdSales": {
            "type": "string",
            "description": "Ad sales during the comparison period."
          },
          "adSpend": {
            "type": "string",
            "description": "Ad spend during the current period."
          },
          "priorAdSpend": {
            "type": "string",
            "description": "Ad spend during the comparison period."
          },
          "acos": {
            "type": "string",
            "description": "Advertising cost of sales during the current period."
          },
          "priorAcos": {
            "type": "string",
            "description": "Advertising cost of sales during the comparison period."
          },
          "tacosOrderedRevenue": {
            "type": "string",
            "description": "Total advertising cost of sales against ordered revenue during the current period."
          },
          "priorTacosOrderedRevenue": {
            "type": "string",
            "description": "Total advertising cost of sales against ordered revenue during the comparison period."
          },
          "tacosShippedRevenue": {
            "type": "string",
            "description": "Total advertising cost of sales against shipped revenue, sourcing, during the current period."
          },
          "priorTacosShippedRevenue": {
            "type": "string",
            "description": "Total advertising cost of sales against shipped revenue, sourcing, during the comparison period."
          },
          "tacosManufacturing": {
            "type": "string",
            "description": "Total advertising cost of sales against shipped revenue, manufacturing, during the current period."
          },
          "priorTacosManufacturing": {
            "type": "string",
            "description": "Total advertising cost of sales against shipped revenue, manufacturing, during the comparison period."
          },
          "impressions": {
            "type": "integer",
            "format": "int32",
            "description": "Impressions during the current period."
          },
          "priorImpressions": {
            "type": "integer",
            "format": "int32",
            "description": "Impressions during the comparison period."
          },
          "clicks": {
            "type": "integer",
            "format": "int32",
            "description": "Clicks during the current period."
          },
          "priorClicks": {
            "type": "integer",
            "format": "int32",
            "description": "Clicks during the comparison period."
          },
          "clickThroughRate": {
            "type": "string",
            "description": "Click through rate during the current period."
          },
          "priorClickThroughRate": {
            "type": "string",
            "description": "Click through rate during the comparison period."
          },
          "currency": {
            "type": "string",
            "description": "Currency code used when formatting the monetary totals."
          }
        }
      },
      "VendorSalesByPeriodSuccessResponse": {
        "type": "object",
        "description": "Successful response returned by the sales-by-period report endpoint.",
        "properties": {
          "status": {
            "type": "string",
            "enum": ["success"],
            "description": "Indicates that the request completed successfully."
          },
          "currency": {
            "type": "string",
            "description": "Currency code associated with the returned metrics."
          },
          "formattedChartData": {
            "type": "array",
            "description": "Display-ready metrics including formatted strings and comparison values for each interval.",
            "items": {
              "$ref": "#/components/schemas/VendorFormattedSalesByPeriodChartData"
            }
          }
        },
        "required": ["status", "currency", "formattedChartData"]
      },
      "SalesByPeriodSuccessResponse": {
        "type": "object",
        "description": "Successful response returned by the sales-by-period report endpoint.",
        "properties": {
          "status": {
            "type": "string",
            "enum": ["success"],
            "description": "Indicates that the request completed successfully."
          },
          "currency": {
            "type": "string",
            "description": "Currency code associated with the returned metrics."
          },
          "formattedChartData": {
            "type": "array",
            "description": "Display-ready metrics including formatted strings and comparison values for each interval.",
            "items": {
              "$ref": "#/components/schemas/FormattedSalesByPeriodChartData"
            }
          }
        },
        "required": ["status", "currency", "formattedChartData"]
      },
      "SalesByPeriodErrorResponse": {
        "type": "object",
        "description": "Error payload returned when the sales-by-period request cannot be processed.",
        "properties": {
          "status": {
            "type": "string",
            "enum": ["error"],
            "description": "Identifies the response as an error."
          },
          "error": {
            "type": "string",
            "description": "Human-readable explanation of what went wrong."
          }
        },
        "required": ["status", "error"]
      },
      "VendorSalesByPeriodErrorResponse": {
        "type": "object",
        "description": "Error payload returned when the sales-by-period request cannot be processed.",
        "properties": {
          "status": {
            "type": "string",
            "enum": ["error"],
            "description": "Identifies the response as an error."
          },
          "error": {
            "type": "string",
            "description": "Human-readable explanation of what went wrong."
          }
        },
        "required": ["status", "error"]
      },
      "ViewSalesByChannelRequest": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CommonReportOptions"
          },
          {
            "type": "object",
            "description": "Request body for viewing sales by channel report",
            "required": [
              "fromDate",
              "toDate",
              "timezone",
              "priorFromDate",
              "priorToDate"
            ],
            "properties": {
              "filter": {
                "type": "object",
                "description": "Filter criteria for the report",
                "properties": {
                  "marketplaces": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Array of marketplace filters",
                    "default": [],
                    "example": []
                  },
                  "countries": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Array of country code filters",
                    "default": [],
                    "example": []
                  },
                  "tags": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Array of tag filters",
                    "default": [],
                    "example": []
                  }
                },
                "default": {
                  "marketplaces": [],
                  "countries": [],
                  "tags": []
                }
              },
              "includeTax": {
                "type": "boolean",
                "description": "Whether to include tax in calculations",
                "default": false,
                "example": false
              },
              "vendorRevenueType": {
                "type": "string",
                "description": "Type of vendor revenue to calculate",
                "enum": ["orderedRevenue", "shippedRevenue"],
                "default": "orderedRevenue",
                "example": "orderedRevenue"
              },
              "sortKey": {
                "type": "string",
                "description": "Field to sort results by",
                "enum": [
                  "sales",
                  "salesSplit",
                  "forecastTarget",
                  "budgetTarget",
                  "orders",
                  "units",
                  "avOrderSize",
                  "avOrderValue",
                  "outOfStockPercentage",
                  "pageViews",
                  "conversions"
                ],
                "default": "sales",
                "example": "sales"
              },
              "sortOrder": {
                "type": "string",
                "description": "Sort order direction",
                "enum": ["asc", "desc"],
                "default": "desc",
                "example": "desc"
              },
              "searchText": {
                "type": "string",
                "description": "Text to search within results",
                "default": "",
                "example": ""
              },
              "pageSize": {
                "type": "integer",
                "description": "Number of items per page for pagination",
                "example": 10
              },
              "pageIndex": {
                "type": "integer",
                "description": "Zero-based page index for pagination",
                "minimum": 0,
                "example": 0
              }
            }
          }
        ]
      },
      "SalesByChannelResponse": {
        "type": "object",
        "description": "Response for sales by channel endpoint containing marketplace overview data",
        "properties": {
          "rows": {
            "type": "array",
            "description": "Array of store/channel data",
            "items": {
              "type": "object",
              "properties": {
                "store": {
                  "type": "string",
                  "description": "Store identifier/name"
                },
                "outOfStockPercentage": {
                  "type": "number",
                  "nullable": true,
                  "description": "Percentage of products out of stock"
                },
                "buyBoxSnapshot": {
                  "type": "object",
                  "nullable": true,
                  "description": "Buy box performance snapshot"
                },
                "forecastTarget": {
                  "type": "number",
                  "description": "Forecast target value"
                },
                "adspendLimit": {
                  "type": "number",
                  "description": "Advertising spend limit"
                },
                "budgetTarget": {
                  "type": "number",
                  "description": "Budget target value"
                },
                "currency": {
                  "type": "string",
                  "description": "Currency code (e.g., USD)"
                },
                "salesSplit": {
                  "type": "number",
                  "description": "Sales split (%)"
                },
                "storeId": {
                  "type": "string",
                  "description": "Unique store identifier"
                },
                "marketplace": {
                  "type": "object",
                  "description": "Marketplace information",
                  "properties": {
                    "market": {
                      "type": "string",
                      "description": "Marketplace type (e.g., amazon, ebay, shopify)"
                    },
                    "countryCode": {
                      "type": "string",
                      "description": "Country code (e.g., USA, CAN, GBR)"
                    }
                  }
                },
                "sales": {
                  "type": "object",
                  "description": "Sales metrics",
                  "properties": {
                    "value": {
                      "type": "number",
                      "description": "Current period sales value"
                    },
                    "priorPeriodValue": {
                      "type": "number",
                      "nullable": true,
                      "description": "Prior period sales value for comparison"
                    }
                  }
                },
                "orders": {
                  "type": "object",
                  "description": "Order metrics",
                  "properties": {
                    "value": {
                      "type": "string",
                      "description": "Current period order count"
                    },
                    "priorPeriodValue": {
                      "type": "string",
                      "description": "Prior period order count for comparison"
                    }
                  }
                },
                "avOrderValue": {
                  "type": "object",
                  "description": "Average order value metrics",
                  "properties": {
                    "value": {
                      "type": "number",
                      "description": "Current period average order value"
                    },
                    "priorPeriodValue": {
                      "type": "number",
                      "nullable": true,
                      "description": "Prior period average order value for comparison"
                    }
                  }
                },
                "units": {
                  "type": "object",
                  "description": "Units sold metrics",
                  "properties": {
                    "value": {
                      "type": "string",
                      "description": "Current period units sold"
                    },
                    "priorPeriodValue": {
                      "type": "string",
                      "description": "Prior period units sold for comparison"
                    }
                  }
                },
                "avOrderSize": {
                  "type": "object",
                  "description": "Average order size metrics",
                  "properties": {
                    "value": {
                      "type": "number",
                      "description": "Current period average order size"
                    },
                    "priorPeriodValue": {
                      "type": "number",
                      "description": "Prior period average order size for comparison"
                    }
                  }
                },
                "pageViews": {
                  "type": "object",
                  "description": "Page view metrics",
                  "properties": {
                    "value": {
                      "type": "string",
                      "description": "Current period page views"
                    },
                    "priorPeriodValue": {
                      "type": "string",
                      "description": "Prior period page views for comparison"
                    }
                  }
                },
                "conversions": {
                  "type": "object",
                  "description": "Conversion rate metrics",
                  "properties": {
                    "value": {
                      "type": "number",
                      "description": "Current period conversion rate"
                    },
                    "priorPeriodValue": {
                      "type": "number",
                      "description": "Prior period conversion rate for comparison"
                    }
                  }
                },
                "healthStatus": {
                  "type": "string",
                  "description": "Health status of the store (e.g., noData, healthy, warning)"
                }
              }
            }
          },
          "count": {
            "type": "number",
            "description": "Total number of stores/channels in the result set"
          }
        }
      },
      "ViewSalesByProductRequest": {
        "type": "object",
        "required": [
          "channelId",
          "merchantId",
          "fromDate",
          "toDate",
          "priorFromDate",
          "priorToDate"
        ],
        "properties": {
          "channelId": {
            "type": "string"
          },
          "merchantId": {
            "type": "string"
          },
          "fromDate": {
            "type": "integer",
            "description": "Unix epoch time (seconds) representing the start of the reporting period"
          },
          "toDate": {
            "type": "integer",
            "description": "Unix epoch time (seconds) representing the end of the reporting period"
          },
          "priorFromDate": {
            "type": "integer",
            "description": "Unix epoch time (seconds) representing the start of the prior comparison period"
          },
          "priorToDate": {
            "type": "integer",
            "description": "Unix epoch time (seconds) representing the end of the prior comparison period"
          },
          "timezone": {
            "type": "string"
          },
          "pageSize": {
            "type": "integer"
          },
          "pageIndex": {
            "type": "integer"
          },
          "sortKey": {
            "type": "string",
            "default": "totalSales"
          },
          "sortOrder": {
            "type": "string",
            "enum": ["asc", "desc"],
            "default": "desc"
          },
          "searchText": {
            "type": "string",
            "default": ""
          },
          "includeNoSales": {
            "type": "boolean",
            "default": false,
            "description": "Whether products with no sales should be included"
          },
          "includeNoInventory": {
            "type": "boolean",
            "default": false,
            "description": "Whether products with zero inventory should be included"
          },
          "includeTax": {
            "type": "boolean",
            "default": false,
            "description": "Whether tax should be included in sales figures"
          }
        }
      },
      "ViewSalesByProductResponse": {
        "type": "object",
        "description": "JSON response for the sales by product view endpoint",
        "properties": {
          "rows": {
            "type": "array",
            "description": "Array of product rows with current and prior period metrics",
            "items": {
              "$ref": "#/components/schemas/SalesByProductRow"
            }
          },
          "count": {
            "type": "integer",
            "description": "Total number of rows matching the query"
          }
        }
      },
      "SalesByProductRow": {
        "type": "object",
        "description": "A single product row containing current and prior period metrics.",
        "properties": {
          "current": {
            "$ref": "#/components/schemas/SalesByProductMetrics"
          },
          "prior": {
            "$ref": "#/components/schemas/SalesByProductMetrics"
          }
        }
      },
      "SalesByProductMetrics": {
        "type": "object",
        "description": "Product performance metrics for a single period.",
        "properties": {
          "productId": {
            "type": "string",
            "description": "Internal product identifier"
          },
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "sku": {
            "type": "string",
            "description": "Seller SKU"
          },
          "productSku": {
            "type": "string",
            "description": "Marketplace product SKU (e.g. ASIN)"
          },
          "linkUrl": {
            "type": "string",
            "description": "Product listing URL"
          },
          "imageUrl": {
            "type": "string",
            "description": "Product image URL"
          },
          "price": {
            "type": "number",
            "description": "Listing price for the period"
          },
          "totalSales": {
            "type": "number",
            "description": "Total sales revenue for the period"
          },
          "unitsSold": {
            "type": "number",
            "description": "Units sold for the period"
          },
          "avPrice": {
            "type": "number",
            "description": "Average selling price"
          },
          "lastSold": {
            "type": "string",
            "description": "Timestamp of the last sale"
          },
          "noQuantitySinceTime": {
            "type": "string",
            "description": "Timestamp since product had zero inventory"
          },
          "acos": {
            "type": "number",
            "description": "Advertising cost of sales (%)"
          },
          "tacos": {
            "type": "number",
            "description": "Total advertising cost of sales (%)"
          },
          "directFulfillmentPOValue": {
            "type": "number",
            "description": "Direct fulfillment purchase order value (vendor only)"
          },
          "directFulfillmentUnits": {
            "type": "number",
            "description": "Direct fulfillment units (vendor only)"
          },
          "directFulfillmentPOValuePercent": {
            "type": "number",
            "description": "Direct fulfillment PO value as percentage of sales (vendor only)"
          },
          "directFulfillmentUnitsPercent": {
            "type": "number",
            "description": "Direct fulfillment units as percentage of sold units (vendor only)"
          }
        },
        "required": ["productId", "totalSales", "unitsSold"]
      },
      "SalesByProductReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Sales By Product report CSV. For Amazon Vendor channels, 'totalSales' is replaced by 'poValue' and 'unitsSold' is replaced by 'unitsOrdered'.",
        "properties": {
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "brand": {
            "type": "string",
            "description": "Brand name"
          },
          "sku": {
            "type": "string",
            "description": "Seller SKU identifier"
          },
          "productSku": {
            "type": "string",
            "description": "Product SKU (e.g. ASIN for Amazon)"
          },
          "id": {
            "type": "string",
            "description": "Product identifier from the source system"
          },
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "imageUrl": {
            "type": "string",
            "description": "URL of the product image"
          },
          "linkUrl": {
            "type": "string",
            "description": "URL to the product listing"
          },
          "quantity": {
            "type": "number",
            "description": "Current inventory quantity"
          },
          "price": {
            "type": "number",
            "description": "Current listing price"
          },
          "totalSales": {
            "type": "number",
            "description": "Total sales revenue in the period (non-vendor channels)"
          },
          "unitsSold": {
            "type": "number",
            "description": "Total units sold in the period (non-vendor channels)"
          },
          "poValue": {
            "type": "number",
            "description": "Purchase order value (Amazon Vendor channels only)"
          },
          "unitsOrdered": {
            "type": "number",
            "description": "Units ordered (Amazon Vendor channels only)"
          },
          "avPrice": {
            "type": "number",
            "description": "Average selling price"
          },
          "lastSold": {
            "type": "string",
            "description": "Date of last sale"
          },
          "noQuantitySinceTime": {
            "type": "string",
            "description": "Date since which the product has had zero quantity"
          },
          "daysCover": {
            "type": "number",
            "description": "Estimated days of inventory cover remaining"
          },
          "salesRank": {
            "type": "number",
            "description": "Product sales rank in its category"
          },
          "shippingPrice": {
            "type": "number",
            "description": "Shipping price"
          },
          "categoryLabel": {
            "type": "string",
            "description": "Product category"
          },
          "parentCategoryLabel": {
            "type": "string",
            "description": "Parent product category"
          },
          "adSpend": {
            "type": "number",
            "description": "Advertising spend in the period"
          },
          "adSales": {
            "type": "number",
            "description": "Sales attributed to advertising"
          },
          "acos": {
            "type": "number",
            "description": "Advertising cost of sales (%)"
          },
          "tacos": {
            "type": "number",
            "description": "Total advertising cost of sales (%)"
          },
          "fulfillmentChannel": {
            "type": "string",
            "description": "Fulfillment method (e.g. FBA, FBM)"
          },
          "status": {
            "type": "string",
            "description": "Product listing status"
          },
          "storeId": {
            "type": "string",
            "description": "Store identifier"
          },
          "productId": {
            "type": "string",
            "description": "Internal product identifier"
          },
          "_id": {
            "type": "string",
            "description": "Document identifier"
          }
        }
      },
      "TrafficAndConversionReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Traffic and Conversion report CSV. When the 'view' option is set to 'skus' (child view), additional columns 'sku' and 'brand' are included.",
        "properties": {
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "productSku": {
            "type": "string",
            "description": "Product SKU (e.g. ASIN)"
          },
          "sku": {
            "type": "string",
            "description": "Seller SKU (included only in child/SKU view)"
          },
          "brand": {
            "type": "string",
            "description": "Brand name (included only in child/SKU view)"
          },
          "pageViews": {
            "type": "number",
            "description": "Number of page views in the current period"
          },
          "priorPageViews": {
            "type": "number",
            "description": "Number of page views in the prior comparison period"
          },
          "orderedRevenue": {
            "type": "number",
            "description": "Ordered revenue in the current period"
          },
          "priorOrderedRevenue": {
            "type": "number",
            "description": "Ordered revenue in the prior comparison period"
          },
          "orderedUnits": {
            "type": "number",
            "description": "Units ordered in the current period"
          },
          "priorOrderedUnits": {
            "type": "number",
            "description": "Units ordered in the prior comparison period"
          },
          "price": {
            "type": "number",
            "description": "Product price"
          },
          "unitsPerView": {
            "type": "number",
            "description": "Conversion rate: units ordered per page view"
          },
          "priorUnitsPerView": {
            "type": "number",
            "description": "Prior period units per page view"
          },
          "unitsPerSession": {
            "type": "number",
            "description": "Units ordered per session"
          },
          "priorUnitsPerSession": {
            "type": "number",
            "description": "Prior period units per session"
          },
          "sessions": {
            "type": "number",
            "description": "Total sessions in the current period"
          },
          "priorSessions": {
            "type": "number",
            "description": "Total sessions in the prior period"
          },
          "mobileSessionsPercentage": {
            "type": "number",
            "description": "Percentage of sessions from mobile devices"
          },
          "priorMobileSessionsPercentage": {
            "type": "number",
            "description": "Prior period mobile sessions percentage"
          },
          "buyboxWinPercentage": {
            "type": "number",
            "description": "Buy Box win percentage"
          },
          "priorBuyboxWinPercentage": {
            "type": "number",
            "description": "Prior period Buy Box win percentage"
          }
        }
      },
      "OrderedRevenueReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Ordered Revenue report CSV (Amazon Vendor). Columns 'vpi' and 'brand' may be included depending on the data granularity.",
        "properties": {
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "vpi": {
            "type": "string",
            "description": "Vendor Product Identifier"
          },
          "brand": {
            "type": "string",
            "description": "Brand name"
          },
          "categoryLabel": {
            "type": "string",
            "description": "Product category"
          },
          "parentCategory": {
            "type": "string",
            "description": "Parent product category"
          },
          "glanceViews": {
            "type": "number",
            "description": "Number of product detail page views"
          },
          "priorGlanceViews": {
            "type": "number",
            "description": "Number of product detail page views (comparison period)"
          },
          "orderedRevenue": {
            "type": "number",
            "description": "Ordered revenue"
          },
          "priorOrderedRevenue": {
            "type": "number",
            "description": "Ordered revenue (comparison period)"
          },
          "orderedUnits": {
            "type": "number",
            "description": "Units ordered"
          },
          "priorOrderedUnits": {
            "type": "number",
            "description": "Units ordered (comparison period)"
          },
          "avgPrice": {
            "type": "number",
            "description": "Average product price"
          },
          "unitsPerGlanceViews": {
            "type": "number",
            "description": "Units ordered per glance view"
          },
          "conversionRate": {
            "type": "number",
            "description": "Conversion rate: Units per view"
          },
          "priorConversionRate": {
            "type": "number",
            "description": "Conversion rate: Units per view (comparison period)"
          }
        }
      },
      "ShippedRevenueReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Shipped Revenue report CSV (Amazon Vendor). The 'view' option selects between 'sourcing' and 'manufacturing' data branches.",
        "properties": {
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "vpi": {
            "type": "string",
            "description": "Vendor Product Identifier"
          },
          "categoryLabel": {
            "type": "string",
            "description": "Product category"
          },
          "parentCategory": {
            "type": "string",
            "description": "Parent product category"
          },
          "brand": {
            "type": "string",
            "description": "Brand name"
          },
          "shippedRevenue": {
            "type": "number",
            "description": "Shipped revenue"
          },
          "priorShippedRevenue": {
            "type": "number",
            "description": "Shipped revenue (comparison period)"
          },
          "shippedCogs": {
            "type": "number",
            "description": "Shipped Cost of Goods Sold"
          },
          "priorShippedCogs": {
            "type": "number",
            "description": "Shipped Cost of Goods Sold (comparison period)"
          },
          "shippedUnits": {
            "type": "number",
            "description": "Units shipped"
          },
          "priorShippedUnits": {
            "type": "number",
            "description": "Units shipped (comparison period)"
          },
          "unitCogs": {
            "type": "number",
            "description": "Cost of Goods Sold per unit"
          },
          "priorUnitCogs": {
            "type": "number",
            "description": "Cost of Goods Sold per unit (comparison period)"
          },
          "amazonMargin": {
            "type": "number",
            "description": "Amazon margin percentage"
          },
          "priorAmazonMargin": {
            "type": "number",
            "description": "Prior period Amazon margin percentage"
          },
          "netPureProductMargin": {
            "type": "number",
            "description": "Net pure product margin percentage"
          }
        }
      },
      "InventoryHealthReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Inventory Health report CSV (Amazon Vendor).",
        "properties": {
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "vpi": {
            "type": "string",
            "description": "Vendor Product Identifier"
          },
          "brand": {
            "type": "string",
            "description": "Brand name"
          },
          "categoryLabel": {
            "type": "string",
            "description": "Product category"
          },
          "sellableInventoryCost": {
            "type": "number",
            "description": "Cost of sellable inventory"
          },
          "sellableInventoryUnits": {
            "type": "number",
            "description": "Number of sellable inventory units"
          },
          "unhealthyInventoryCost": {
            "type": "number",
            "description": "Cost of unhealthy inventory"
          },
          "unhealthyInventoryUnits": {
            "type": "number",
            "description": "Number of unhealthy inventory units"
          },
          "aged90DaysCost": {
            "type": "number",
            "description": "Cost of inventory aged over 90 days"
          },
          "aged90DaysUnits": {
            "type": "number",
            "description": "Units of inventory aged over 90 days"
          },
          "unsellableInventoryCost": {
            "type": "number",
            "description": "Cost of unsellable inventory"
          },
          "unsellableInventoryUnits": {
            "type": "number",
            "description": "Number of unsellable inventory units"
          },
          "receivedInventoryCost": {
            "type": "number",
            "description": "Cost of received inventory"
          },
          "receivedInventoryUnits": {
            "type": "number",
            "description": "Number of received inventory units"
          },
          "unitsShipped": {
            "type": "number",
            "description": "Total units shipped"
          },
          "daysCover": {
            "type": "number",
            "description": "Estimated days of inventory cover"
          },
          "unfilledInventory": {
            "type": "number",
            "description": "Unfilled inventory units"
          },
          "openPo": {
            "type": "number",
            "description": "Open purchase orders"
          },
          "sellThroughRate": {
            "type": "number",
            "description": "Sell-through rate (%)"
          },
          "averageVendorLeadTimeDays": {
            "type": "number",
            "description": "Average vendor lead time in days"
          },
          "netFilledRate": {
            "type": "number",
            "description": "Net filled rate (received units / total ordered units)"
          },
          "sourceableProductOutOfStockRate": {
            "type": "number",
            "description": "Out of stock rate for sourceable products (%)"
          },
          "procurableProductOutOfStockRate": {
            "type": "number",
            "description": "Out of stock rate for procurable products (%)"
          }
        }
      },
      "InventoryReplenishmentReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Inventory Replenishment report CSV (Amazon FBA).",
        "properties": {
          "sku": {
            "type": "string",
            "description": "Seller SKU"
          },
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "productName": {
            "type": "string",
            "description": "Product name"
          },
          "storageType": {
            "type": "string",
            "description": "FBA storage type classification"
          },
          "daysCover": {
            "type": "number",
            "description": "Estimated days of inventory cover"
          },
          "projectedOOSDate": {
            "type": "string",
            "description": "Projected out-of-stock date"
          },
          "estimatedReorderDate": {
            "type": "string",
            "description": "Estimated date by which to reorder"
          },
          "totalInventory": {
            "type": "number",
            "description": "Total inventory units across all locations"
          },
          "available": {
            "type": "number",
            "description": "Units available for sale"
          },
          "reservedQuantity": {
            "type": "number",
            "description": "Units reserved (e.g. pending orders)"
          },
          "inboundQuantity": {
            "type": "number",
            "description": "Units currently inbound to FBA"
          },
          "unfulfillableQuantity": {
            "type": "number",
            "description": "Unfulfillable inventory units"
          },
          "fcTransfer": {
            "type": "number",
            "description": "Intra warehouse transfer quantity"
          },
          "awdOnhandQuantity": {
            "type": "number",
            "description": "Amazon Warehousing and Distribution on-hand quantity"
          },
          "awdInboundQuantity": {
            "type": "number",
            "description": "Amazon Warehousing and Distribution inbound quantity"
          },
          "storageVolume": {
            "type": "number",
            "description": "Storage volume occupied"
          },
          "estimatedStorageCostNextMonth": {
            "type": "number",
            "description": "Estimated storage cost for the next month"
          },
          "dailySales7": {
            "type": "number",
            "description": "Average daily sales over the last 7 days"
          },
          "dailySales30": {
            "type": "number",
            "description": "Average daily sales over the last 30 days"
          },
          "dailySales60": {
            "type": "number",
            "description": "Average daily sales over the last 60 days"
          },
          "dailySales90": {
            "type": "number",
            "description": "Average daily sales over the last 90 days"
          },
          "replenUnits": {
            "type": "number",
            "description": "Recommended replenishment units"
          },
          "replenCases": {
            "type": "number",
            "description": "Recommended replenishment cases"
          },
          "unitsPerCase": {
            "type": "number",
            "description": "Number of units per case"
          }
        }
      },
      "CampaignsReportColumns": {
        "type": "object",
        "description": "The campaigns report generates multiple CSV files: campaigns, ad groups, keywords, product ads, and products. See the sub-schemas below for the columns in each file.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/CampaignsReportCampaignColumns"
          },
          {
            "$ref": "#/components/schemas/CampaignsReportAdGroupColumns"
          },
          {
            "$ref": "#/components/schemas/CampaignsReportKeywordColumns"
          },
          {
            "$ref": "#/components/schemas/CampaignsReportProductAdColumns"
          },
          {
            "$ref": "#/components/schemas/CampaignsReportProductColumns"
          }
        ]
      },
      "CampaignsReportCampaignColumns": {
        "type": "object",
        "description": "Columns in the campaigns CSV file of the Campaigns report download.",
        "properties": {
          "campaign_id": {
            "type": "string",
            "description": "Campaign identifier"
          },
          "ad_type": {
            "type": "string",
            "description": "Type of ad (e.g. SP, SB, SD)"
          },
          "seller_id": {
            "type": "string",
            "description": "Seller identifier"
          },
          "marketplace_id": {
            "type": "string",
            "description": "Amazon marketplace code"
          },
          "report_date": {
            "type": "string",
            "description": "Report date"
          },
          "campaign_name": {
            "type": "string",
            "description": "Campaign name"
          },
          "campaign_status": {
            "type": "string",
            "description": "Campaign status (e.g. active, paused, archived)"
          },
          "budget": {
            "type": "number",
            "description": "Campaign budget"
          },
          "budget_type": {
            "type": "string",
            "description": "Budget type (e.g. daily, lifetime)"
          },
          "start_date": {
            "type": "string",
            "description": "Campaign start date"
          },
          "end_date": {
            "type": "string",
            "nullable": true,
            "description": "Campaign end date"
          },
          "targeting_type": {
            "type": "string",
            "nullable": true,
            "description": "Targeting method"
          },
          "bidding_strategy": {
            "type": "string",
            "nullable": true,
            "description": "Bidding strategy"
          },
          "impressions": {
            "type": "number",
            "description": "Total impressions"
          },
          "clicks": {
            "type": "number",
            "description": "Total clicks"
          },
          "cost": {
            "type": "number",
            "description": "Total ad spend"
          },
          "attributed_sales": {
            "type": "number",
            "description": "Total sales attributed to ads"
          },
          "attributed_sales_same_sku": {
            "type": "number",
            "description": "Sales attributed to the same SKU"
          },
          "attributed_conversions": {
            "type": "number",
            "description": "Total conversions attributed to ads"
          },
          "attributed_conversions_same_sku": {
            "type": "number",
            "description": "Conversions attributed to the same SKU"
          },
          "attributed_units_ordered": {
            "type": "number",
            "description": "Total units ordered attributed to ads"
          },
          "attributed_units_ordered_same_sku": {
            "type": "number",
            "description": "Units ordered for the same SKU"
          },
          "attributed_orders_ntb": {
            "type": "number",
            "description": "New-to-brand orders"
          },
          "attributed_orders_ntb_percentage": {
            "type": "number",
            "description": "New-to-brand orders as a percentage of total"
          },
          "attributed_units_ordered_ntb": {
            "type": "number",
            "description": "New-to-brand units ordered"
          },
          "attributed_units_ordered_ntb_percentage": {
            "type": "number",
            "description": "New-to-brand units as a percentage of total"
          },
          "attributed_sales_ntb": {
            "type": "number",
            "description": "New-to-brand sales"
          },
          "attributed_sales_ntb_percentage": {
            "type": "number",
            "description": "New-to-brand sales as a percentage of total"
          },
          "attributed_detail_page_views_clicks": {
            "type": "number",
            "description": "Detail page view clicks attributed to ads"
          },
          "acos": {
            "type": "number",
            "description": "Advertising cost of sales (%)"
          },
          "click_through_rate": {
            "type": "number",
            "description": "Click-through rate (%)"
          },
          "cost_per_click": {
            "type": "number",
            "description": "Average cost per click"
          },
          "conversion_rate": {
            "type": "number",
            "description": "Conversion rate (%)"
          },
          "roas": {
            "type": "number",
            "description": "Return on Ad Spend"
          }
        }
      },
      "CampaignsReportAdGroupColumns": {
        "type": "object",
        "description": "Columns in the ad groups CSV file of the Campaigns report download.",
        "properties": {
          "campaign_id": {
            "type": "string",
            "description": "Parent campaign identifier"
          },
          "ad_group_id": {
            "type": "string",
            "description": "Ad group identifier"
          },
          "ad_type": {
            "type": "string",
            "description": "Type of ad (e.g. SP, SB, SD)"
          },
          "seller_id": {
            "type": "string",
            "description": "Seller identifier"
          },
          "marketplace_id": {
            "type": "string",
            "description": "Amazon marketplace code"
          },
          "report_date": {
            "type": "string",
            "description": "Report date"
          },
          "campaign_name": {
            "type": "string",
            "description": "Parent campaign name"
          },
          "ad_group_name": {
            "type": "string",
            "description": "Ad group name"
          },
          "ad_group_status": {
            "type": "string",
            "description": "Ad group status (e.g. enabled, paused)"
          },
          "default_bid": {
            "type": "number",
            "nullable": true,
            "description": "Default bid amount"
          },
          "impressions": {
            "type": "number",
            "description": "Total impressions"
          },
          "clicks": {
            "type": "number",
            "description": "Total clicks"
          },
          "cost": {
            "type": "number",
            "description": "Total ad spend"
          },
          "attributed_sales": {
            "type": "number",
            "description": "Total sales attributed to ads"
          },
          "attributed_sales_same_sku": {
            "type": "number",
            "description": "Sales attributed to the same SKU"
          },
          "attributed_conversions": {
            "type": "number",
            "description": "Total conversions attributed to ads"
          },
          "attributed_conversions_same_sku": {
            "type": "number",
            "description": "Conversions attributed to the same SKU"
          },
          "attributed_units_ordered": {
            "type": "number",
            "description": "Total units ordered attributed to ads"
          },
          "attributed_units_ordered_same_sku": {
            "type": "number",
            "description": "Units ordered for the same SKU"
          },
          "attributed_orders_ntb": {
            "type": "number",
            "description": "New-to-brand orders"
          },
          "attributed_orders_ntb_percentage": {
            "type": "number",
            "description": "New-to-brand orders as a percentage of total"
          },
          "attributed_units_ordered_ntb": {
            "type": "number",
            "description": "New-to-brand units ordered"
          },
          "attributed_units_ordered_ntb_percentage": {
            "type": "number",
            "description": "New-to-brand units as a percentage of total"
          },
          "attributed_sales_ntb": {
            "type": "number",
            "description": "New-to-brand sales"
          },
          "attributed_sales_ntb_percentage": {
            "type": "number",
            "description": "New-to-brand sales as a percentage of total"
          },
          "attributed_detail_page_views_clicks": {
            "type": "number",
            "description": "Detail page view clicks attributed to ads"
          },
          "acos": {
            "type": "number",
            "description": "Advertising cost of sales (%)"
          },
          "click_through_rate": {
            "type": "number",
            "description": "Click-through rate (%)"
          },
          "cost_per_click": {
            "type": "number",
            "description": "Average cost per click"
          },
          "conversion_rate": {
            "type": "number",
            "description": "Conversion rate (%)"
          },
          "roas": {
            "type": "number",
            "description": "Return on Ad Spend"
          }
        }
      },
      "CampaignsReportKeywordColumns": {
        "type": "object",
        "description": "Columns in the keywords CSV file of the Campaigns report download.",
        "properties": {
          "campaign_id": {
            "type": "string",
            "description": "Parent campaign identifier"
          },
          "ad_group_id": {
            "type": "string",
            "description": "Parent ad group identifier"
          },
          "keyword_id": {
            "type": "string",
            "description": "Keyword identifier"
          },
          "ad_type": {
            "type": "string",
            "description": "Type of ad (e.g. SP, SB, SD)"
          },
          "seller_id": {
            "type": "string",
            "description": "Seller identifier"
          },
          "marketplace_id": {
            "type": "string",
            "description": "Amazon marketplace code"
          },
          "report_date": {
            "type": "string",
            "description": "Report date"
          },
          "campaign_name": {
            "type": "string",
            "description": "Parent campaign name"
          },
          "ad_group_name": {
            "type": "string",
            "description": "Parent ad group name"
          },
          "keyword_text": {
            "type": "string",
            "description": "The keyword text"
          },
          "match_type": {
            "type": "string",
            "description": "Keyword match type (e.g. broad, phrase, exact)"
          },
          "keyword_status": {
            "type": "string",
            "description": "Keyword status (e.g. enabled, paused)"
          },
          "bid": {
            "type": "number",
            "nullable": true,
            "description": "Keyword bid amount"
          },
          "impressions": {
            "type": "number",
            "description": "Total impressions"
          },
          "clicks": {
            "type": "number",
            "description": "Total clicks"
          },
          "cost": {
            "type": "number",
            "description": "Total ad spend"
          },
          "attributed_sales": {
            "type": "number",
            "description": "Total sales attributed to ads"
          },
          "attributed_sales_same_sku": {
            "type": "number",
            "description": "Sales attributed to the same SKU"
          },
          "attributed_conversions": {
            "type": "number",
            "description": "Total conversions attributed to ads"
          },
          "attributed_conversions_same_sku": {
            "type": "number",
            "description": "Conversions attributed to the same SKU"
          },
          "attributed_units_ordered": {
            "type": "number",
            "description": "Total units ordered attributed to ads"
          },
          "attributed_units_ordered_same_sku": {
            "type": "number",
            "description": "Units ordered for the same SKU"
          },
          "attributed_orders_ntb": {
            "type": "number",
            "description": "New-to-brand orders"
          },
          "attributed_orders_ntb_percentage": {
            "type": "number",
            "description": "New-to-brand orders as a percentage of total"
          },
          "attributed_units_ordered_ntb": {
            "type": "number",
            "description": "New-to-brand units ordered"
          },
          "attributed_units_ordered_ntb_percentage": {
            "type": "number",
            "description": "New-to-brand units as a percentage of total"
          },
          "attributed_sales_ntb": {
            "type": "number",
            "description": "New-to-brand sales"
          },
          "attributed_sales_ntb_percentage": {
            "type": "number",
            "description": "New-to-brand sales as a percentage of total"
          },
          "attributed_detail_page_views_clicks": {
            "type": "number",
            "description": "Detail page view clicks attributed to ads"
          },
          "acos": {
            "type": "number",
            "description": "Advertising cost of sales (%)"
          },
          "click_through_rate": {
            "type": "number",
            "description": "Click-through rate (%)"
          },
          "cost_per_click": {
            "type": "number",
            "description": "Average cost per click"
          },
          "conversion_rate": {
            "type": "number",
            "description": "Conversion rate (%)"
          },
          "roas": {
            "type": "number",
            "description": "Return on Ad Spend"
          }
        }
      },
      "CampaignsReportProductAdColumns": {
        "type": "object",
        "description": "Columns in the product ads CSV file of the Campaigns report download.",
        "properties": {
          "campaign_id": {
            "type": "string",
            "description": "Parent campaign identifier"
          },
          "ad_id": {
            "type": "string",
            "description": "Product ad identifier"
          },
          "ad_type": {
            "type": "string",
            "description": "Type of ad (e.g. SP, SB, SD)"
          },
          "seller_id": {
            "type": "string",
            "description": "Seller identifier"
          },
          "marketplace_id": {
            "type": "string",
            "description": "Amazon marketplace code"
          },
          "report_date": {
            "type": "string",
            "description": "Report date"
          },
          "campaign_name": {
            "type": "string",
            "description": "Parent campaign name"
          },
          "ad_group_name": {
            "type": "string",
            "description": "Parent ad group name"
          },
          "product_ad_status": {
            "type": "string",
            "description": "Product ad status (e.g. enabled, paused)"
          },
          "product_id": {
            "type": "string",
            "description": "Product identifier"
          },
          "product_title": {
            "type": "string",
            "description": "Product title"
          },
          "image_url": {
            "type": "string",
            "description": "Product image URL"
          },
          "link_url": {
            "type": "string",
            "description": "Product listing URL"
          },
          "sku": {
            "type": "string",
            "description": "Seller SKU"
          },
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "impressions": {
            "type": "number",
            "description": "Total impressions"
          },
          "clicks": {
            "type": "number",
            "description": "Total clicks"
          },
          "cost": {
            "type": "number",
            "description": "Total ad spend"
          },
          "attributed_sales": {
            "type": "number",
            "description": "Total sales attributed to ads"
          },
          "attributed_sales_same_sku": {
            "type": "number",
            "description": "Sales attributed to the same SKU"
          },
          "attributed_conversions": {
            "type": "number",
            "description": "Total conversions attributed to ads"
          },
          "attributed_conversions_same_sku": {
            "type": "number",
            "description": "Conversions attributed to the same SKU"
          },
          "attributed_units_ordered": {
            "type": "number",
            "description": "Total units ordered attributed to ads"
          },
          "attributed_units_ordered_same_sku": {
            "type": "number",
            "description": "Units ordered for the same SKU"
          },
          "acos": {
            "type": "number",
            "description": "Advertising cost of sales (%)"
          },
          "click_through_rate": {
            "type": "number",
            "description": "Click-through rate (%)"
          },
          "cost_per_click": {
            "type": "number",
            "description": "Average cost per click"
          },
          "conversion_rate": {
            "type": "number",
            "description": "Conversion rate (%)"
          },
          "roas": {
            "type": "number",
            "description": "Return on Ad Spend"
          }
        }
      },
      "CampaignsReportProductColumns": {
        "type": "object",
        "description": "Columns in the products CSV file of the Campaigns report download. Aggregated product-level advertising performance.",
        "properties": {
          "seller_id": {
            "type": "string",
            "description": "Seller identifier"
          },
          "marketplace_id": {
            "type": "string",
            "description": "Amazon marketplace code"
          },
          "report_date": {
            "type": "string",
            "description": "Report date"
          },
          "product_ad_status": {
            "type": "string",
            "description": "Product ad status"
          },
          "product_id": {
            "type": "string",
            "description": "Product identifier"
          },
          "product_title": {
            "type": "string",
            "description": "Product title"
          },
          "image_url": {
            "type": "string",
            "description": "Product image URL"
          },
          "link_url": {
            "type": "string",
            "description": "Product listing URL"
          },
          "sku": {
            "type": "string",
            "description": "Seller SKU"
          },
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "impressions": {
            "type": "number",
            "description": "Total impressions"
          },
          "clicks": {
            "type": "number",
            "description": "Total clicks"
          },
          "cost": {
            "type": "number",
            "description": "Total ad spend"
          },
          "attributed_sales": {
            "type": "number",
            "description": "Total sales attributed to ads"
          },
          "attributed_sales_same_sku": {
            "type": "number",
            "description": "Sales attributed to the same SKU"
          },
          "attributed_conversions": {
            "type": "number",
            "description": "Total conversions attributed to ads"
          },
          "attributed_conversions_same_sku": {
            "type": "number",
            "description": "Conversions attributed to the same SKU"
          },
          "attributed_units_ordered": {
            "type": "number",
            "description": "Total units ordered attributed to ads"
          },
          "attributed_units_ordered_same_sku": {
            "type": "number",
            "description": "Units ordered for the same SKU"
          },
          "acos": {
            "type": "number",
            "description": "Advertising cost of sales (%)"
          },
          "click_through_rate": {
            "type": "number",
            "description": "Click-through rate (%)"
          },
          "cost_per_click": {
            "type": "number",
            "description": "Average cost per click"
          },
          "conversion_rate": {
            "type": "number",
            "description": "Conversion rate (%)"
          },
          "roas": {
            "type": "number",
            "description": "Return on Ad Spend"
          }
        }
      },
      "ChannelProfitAndLossReportColumns": {
        "type": "object",
        "description": "Rows present in the downloadable Channel Profit and Loss report CSV. This export is pivot-style with dynamic headers: the first column is a metric label, and remaining columns are either ['value', 'percentageIncome', 'valuePerUnit'] or ['Total', &lt;month columns&gt;].",
        "properties": {
          "rowLabel": {
            "type": "string",
            "description": "Metric or breakdown label in the first column"
          },
          "value": {
            "type": "string",
            "description": "Value column used in non-monthly view"
          },
          "percentageIncome": {
            "type": "string",
            "description": "Percentage of revenue column used in non-monthly view"
          },
          "valuePerUnit": {
            "type": "string",
            "description": "Value-per-unit column used in non-monthly view"
          },
          "Total": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              }
            ],
            "description": "Total column used in monthly view"
          }
        },
        "additionalProperties": {
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "number"
            }
          ]
        }
      },
      "AmazonBuyBoxPerformanceReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Amazon Buy Box Performance report CSV. An additional 'offerPoints' column is included for Japanese marketplaces.",
        "properties": {
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "sellerSku": {
            "type": "string",
            "description": "Seller SKU"
          },
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "quantity": {
            "type": "number",
            "description": "Current inventory quantity"
          },
          "isFulfilledByAmazon": {
            "type": "boolean",
            "description": "Whether the product is fulfilled by Amazon (FBA)"
          },
          "yourStatus": {
            "type": "string",
            "description": "Your listing status"
          },
          "yourPriceCurrencyCode": {
            "type": "string",
            "description": "Currency code of your price"
          },
          "yourPriceAmount": {
            "type": "number",
            "description": "Your listing price"
          },
          "competitivePriceCurrencyCode": {
            "type": "string",
            "description": "Currency code of the competitive price"
          },
          "competitivePriceAmount": {
            "type": "number",
            "description": "Competitive listing price"
          },
          "offerRank": {
            "type": "number",
            "description": "Rank of this offer among competing offers"
          },
          "offerSellerId": {
            "type": "string",
            "description": "Seller ID of the offer"
          },
          "offerIsFulfilledByAmazon": {
            "type": "boolean",
            "description": "Whether the competing offer is FBA"
          },
          "offerIsPrime": {
            "type": "boolean",
            "description": "Whether the offer is Prime eligible"
          },
          "offerIsNationalPrime": {
            "type": "boolean",
            "description": "Whether the offer is National Prime"
          },
          "offerIsBuyBoxWinner": {
            "type": "boolean",
            "description": "Whether this offer currently wins the Buy Box"
          },
          "offerIsFeaturedMerchant": {
            "type": "boolean",
            "description": "Whether the seller is a Featured Merchant"
          },
          "offerListingPriceCurrencyCode": {
            "type": "string",
            "description": "Currency code of the offer listing price"
          },
          "offerListingPriceAmount": {
            "type": "number",
            "description": "Offer listing price"
          },
          "offerShippingCurrencyCode": {
            "type": "string",
            "description": "Currency code of the offer shipping"
          },
          "offerShippingAmount": {
            "type": "number",
            "description": "Offer shipping cost"
          },
          "offerShippingTime": {
            "type": "string",
            "description": "Offer shipping time estimate"
          },
          "offerShipsDomestically": {
            "type": "boolean",
            "description": "Whether the offer ships domestically"
          },
          "offerSellerPositiveFeedbackRating": {
            "type": "number",
            "description": "Seller's positive feedback rating (%)"
          },
          "offerFeedbackCount": {
            "type": "number",
            "description": "Total seller feedback count"
          },
          "offerPoints": {
            "type": "number",
            "description": "Offer points (Japanese marketplaces only)"
          }
        }
      },
      "CustomerLifetimeValueReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Customer Lifetime Value report CSV.",
        "properties": {
          "startTime": {
            "type": "string",
            "description": "Start of the cohort time period"
          },
          "totalRevenue": {
            "type": "number",
            "description": "Total revenue from all customers"
          },
          "repeatCustomersRevenue": {
            "type": "number",
            "description": "Revenue from repeat customers"
          },
          "repeatRevenuePercentage": {
            "type": "number",
            "description": "Percentage of revenue from repeat customers"
          },
          "totalCustomers": {
            "type": "number",
            "description": "Total number of customers"
          },
          "repeatCustomers": {
            "type": "number",
            "description": "Number of repeat customers"
          },
          "repeatCustomersPercentage": {
            "type": "number",
            "description": "Percentage of customers who are repeat buyers"
          },
          "averageLTV": {
            "type": "number",
            "description": "Average lifetime value per customer"
          },
          "averageRepeatLTV": {
            "type": "number",
            "description": "Average lifetime value per repeat customer"
          },
          "adSpend": {
            "type": "number",
            "description": "Advertising spend in the period"
          },
          "cac": {
            "type": "number",
            "description": "Customer Acquisition Cost"
          },
          "ltvCacRatio": {
            "type": "number",
            "description": "Ratio of lifetime value to customer acquisition cost"
          },
          "repeatPurchases": {
            "type": "number",
            "description": "Number of repeat purchases"
          },
          "purchaseFrequency": {
            "type": "number",
            "description": "Average purchase frequency"
          },
          "currency": {
            "type": "string",
            "description": "Currency code (e.g. USD, GBP)"
          }
        }
      },
      "CancellationsAndRefundsReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Cancellations and Refunds report CSV. Note: cancelledSales, priorCancelledSales, cancelRate, and priorCancelRate columns are hidden for Amazon seller channels.",
        "properties": {
          "productId": {
            "type": "string",
            "description": "Product identifier"
          },
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "imageUrl": {
            "type": "string",
            "description": "Product image URL"
          },
          "linkUrl": {
            "type": "string",
            "description": "Product listing URL"
          },
          "grossSales": {
            "type": "number",
            "description": "Gross sales"
          },
          "priorGrossSales": {
            "type": "number",
            "description": "Gross sales (comparison period)"
          },
          "cancelledSales": {
            "type": "number",
            "description": "Cancelled sales value. Not available for Amazon sellers"
          },
          "priorCancelledSales": {
            "type": "number",
            "description": "Cancelled sales value (comparison period). Not available for Amazon sellers"
          },
          "cancelRate": {
            "type": "number",
            "description": "Cancellation rate (%). Not available for Amazon sellers"
          },
          "priorCancelRate": {
            "type": "number",
            "description": "Cancellation rate (%) (comparison period). Not available for Amazon sellers"
          },
          "netSales": {
            "type": "number",
            "description": "Net sales"
          },
          "priorNetSales": {
            "type": "number",
            "description": "Net sales (comparison period)"
          },
          "grossQty": {
            "type": "number",
            "description": "Gross quantity ordered"
          },
          "priorGrossQty": {
            "type": "number",
            "description": "Gross quantity ordered (comparison period)"
          },
          "refundedSales": {
            "type": "number",
            "description": "Refunded sales value"
          },
          "priorRefundedSales": {
            "type": "number",
            "description": "Refunded sales value (comparison period)"
          },
          "unitsRefunded": {
            "type": "number",
            "description": "Number of units refunded"
          },
          "priorUnitsRefunded": {
            "type": "number",
            "description": "Number of units refunded (comparison period)"
          },
          "refundRate": {
            "type": "number",
            "description": "Refund rate percentage"
          },
          "priorRefundRate": {
            "type": "number",
            "description": "Refund rate percentage (comparison period)"
          },
          "refundRateUnits": {
            "type": "number",
            "description": "Refund rate by units"
          },
          "priorRefundRateUnits": {
            "type": "number",
            "description": "Refund rate by units (comparison period)"
          },
          "unitsCancelled": {
            "type": "number",
            "description": "Number of units cancelled"
          },
          "priorUnitsCancelled": {
            "type": "number",
            "description": "Number of units cancelled (comparison period)"
          },
          "currency": {
            "type": "string",
            "description": "Currency code (e.g. USD, GBP)"
          }
        }
      },
      "RepeatPurchaseReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Repeat Purchase report CSV.",
        "properties": {
          "productSku": {
            "type": "string",
            "description": "Product SKU"
          },
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "totalSales": {
            "type": "number",
            "description": "Total sales"
          },
          "priorTotalSales": {
            "type": "number",
            "description": "Total sales (comparison period)"
          },
          "repeatCustomerSales": {
            "type": "number",
            "description": "Sales from repeat customers"
          },
          "priorRepeatCustomerSales": {
            "type": "number",
            "description": "Sales from repeat customers (comparison period)"
          },
          "repeatSalesPercentage": {
            "type": "number",
            "description": "Percentage of sales from repeat customers"
          },
          "priorRepeatSalesPercentage": {
            "type": "number",
            "description": "Percentage of sales from repeat customers (comparison period)"
          },
          "totalCustomers": {
            "type": "number",
            "description": "Total customers"
          },
          "priorTotalCustomers": {
            "type": "number",
            "description": "Total customers (comparison period)"
          },
          "newCustomers": {
            "type": "number",
            "description": "New customers"
          },
          "priorNewCustomers": {
            "type": "number",
            "description": "New customers (comparison period)"
          },
          "repeatCustomers": {
            "type": "number",
            "description": "Repeat customers"
          },
          "priorRepeatCustomers": {
            "type": "number",
            "description": "Repeat customers (comparison period)"
          },
          "repeatCustomersPercentage": {
            "type": "number",
            "description": "Percentage of customers who are repeat buyers"
          },
          "priorRepeatCustomersPercentage": {
            "type": "number",
            "description": "Percentage of customers who are repeat buyers (comparison period)"
          },
          "salesPerCustomer": {
            "type": "number",
            "description": "Average sales per customer"
          },
          "salesPerRepeatCustomer": {
            "type": "number",
            "description": "Average sales per repeat customer"
          },
          "currency": {
            "type": "string",
            "description": "Currency code (e.g. USD, GBP)"
          }
        }
      },
      "SubscribeAndSaveReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Subscribe and Save report CSV (Amazon).",
        "properties": {
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "sku": {
            "type": "string",
            "description": "Seller SKU"
          },
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "currentSubscriberShippedRevenue": {
            "type": "number",
            "description": "Subscriber shipped revenue"
          },
          "priorSubscriberShippedRevenue": {
            "type": "number",
            "description": "Subscriber shipped revenue (comparison period)"
          },
          "currentSubscribers": {
            "type": "number",
            "description": "Number of active subscribers"
          },
          "priorSubscribers": {
            "type": "number",
            "description": "Number of active subscribers (comparison period)"
          },
          "currentRevenuePerSubscriber": {
            "type": "number",
            "description": "Revenue per subscriber"
          },
          "priorRevenuePerSubscriber": {
            "type": "number",
            "description": "Revenue per subscriber (comparison period)"
          },
          "currentShippedSubscriptionUnits": {
            "type": "number",
            "description": "Shipped subscription units"
          },
          "priorShippedSubscriptionUnits": {
            "type": "number",
            "description": "Shipped subscription units (comparison period)"
          },
          "currentRevenuePenetration": {
            "type": "number",
            "description": "Revenue penetration rate"
          },
          "priorRevenuePenetration": {
            "type": "number",
            "description": "Revenue penetration rate (comparison period)"
          },
          "notDeliveredDueToOOSPercent": {
            "type": "number",
            "description": "Percentage of subscriptions not delivered due to out of stock"
          },
          "baseDiscount": {
            "type": "number",
            "description": "Base Subscribe and Save discount percentage"
          },
          "tierDiscount": {
            "type": "number",
            "description": "Tier-based discount percentage"
          },
          "enrollment": {
            "type": "string",
            "description": "Enrollment status"
          },
          "eligibility": {
            "type": "string",
            "description": "Product eligibility status for Subscribe and Save"
          }
        }
      },
      "ProductsReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Products report CSV (Amazon). This endpoint requires an Enterprise plan.",
        "properties": {
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "sku": {
            "type": "string",
            "description": "Seller SKU"
          },
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "brand": {
            "type": "string",
            "description": "Brand name"
          },
          "price": {
            "type": "number",
            "description": "Current listing price"
          },
          "shippingPrice": {
            "type": "number",
            "description": "Shipping price"
          },
          "fulfillmentType": {
            "type": "string",
            "description": "Fulfillment type (e.g. FBA, FBM)"
          },
          "inventoryLevel": {
            "type": "number",
            "description": "Current inventory level"
          },
          "cogs": {
            "type": "number",
            "description": "Cost of Goods Sold per unit"
          },
          "imageUrl": {
            "type": "string",
            "description": "Product image URL"
          },
          "categoryLabel": {
            "type": "string",
            "description": "Product category"
          },
          "parentCategoryLabel": {
            "type": "string",
            "description": "Parent product category"
          },
          "feesEstimate": {
            "type": "number",
            "description": "Estimated selling fees"
          },
          "vat": {
            "type": "number",
            "description": "VAT amount"
          },
          "returnRate": {
            "type": "number",
            "description": "Product return rate"
          },
          "parentAsin": {
            "type": "string",
            "description": "Parent ASIN for product variations"
          },
          "currency": {
            "type": "string",
            "description": "Currency code (e.g. USD, GBP)"
          }
        }
      },
      "SuppressedProductReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Suppressed Product report CSV.",
        "properties": {
          "sellerSku": {
            "type": "string",
            "description": "Seller SKU"
          },
          "productSku": {
            "type": "string",
            "description": "Product SKU (e.g. ASIN)"
          },
          "title": {
            "type": "string",
            "description": "Product title"
          },
          "inventory": {
            "type": "number",
            "description": "Current available inventory quantity"
          },
          "dateSuppressed": {
            "type": "string",
            "description": "Date the listing was suppressed"
          },
          "salesValue": {
            "type": "number",
            "description": "Estimated lost sales value due to suppression"
          },
          "price": {
            "type": "number",
            "description": "Product listing price"
          },
          "issueCount": {
            "type": "number",
            "description": "Number of listing issues causing suppression"
          },
          "issueTypes": {
            "type": "string",
            "description": "Types of issues causing suppression"
          },
          "fixUrl": {
            "type": "string",
            "description": "URL to fix the listing issues"
          },
          "linkUrl": {
            "type": "string",
            "description": "URL to the product listing"
          }
        }
      },
      "MarketingByProductReportColumns": {
        "type": "object",
        "description": "Columns present in the downloadable Marketing by Product report CSV. This export uses product-level Amazon advertising rows.",
        "properties": {
          "seller_id": {
            "type": "string",
            "description": "Seller identifier"
          },
          "marketplace_id": {
            "type": "string",
            "description": "Amazon marketplace code"
          },
          "report_date": {
            "type": "string",
            "description": "Report date"
          },
          "product_ad_status": {
            "type": "string",
            "description": "Product ad status"
          },
          "product_id": {
            "type": "string",
            "description": "Product identifier"
          },
          "product_title": {
            "type": "string",
            "description": "Product title"
          },
          "image_url": {
            "type": "string",
            "description": "Product image URL"
          },
          "link_url": {
            "type": "string",
            "description": "Product listing URL"
          },
          "sku": {
            "type": "string",
            "description": "Seller SKU"
          },
          "asin": {
            "type": "string",
            "description": "Amazon Standard Identification Number"
          },
          "impressions": {
            "type": "number",
            "description": "Total impressions"
          },
          "clicks": {
            "type": "number",
            "description": "Total clicks"
          },
          "cost": {
            "type": "number",
            "description": "Total ad spend"
          },
          "attributed_sales": {
            "type": "number",
            "description": "Total sales attributed to ads"
          },
          "attributed_sales_same_sku": {
            "type": "number",
            "description": "Sales attributed to the same SKU"
          },
          "attributed_conversions": {
            "type": "number",
            "description": "Total conversions attributed to ads"
          },
          "attributed_conversions_same_sku": {
            "type": "number",
            "description": "Conversions attributed to the same SKU"
          },
          "attributed_units_ordered": {
            "type": "number",
            "description": "Total units ordered attributed to ads"
          },
          "attributed_units_ordered_same_sku": {
            "type": "number",
            "description": "Units ordered for the same SKU"
          },
          "acos": {
            "type": "number",
            "description": "Advertising cost of sales (%)"
          },
          "click_through_rate": {
            "type": "number",
            "description": "Click-through rate (%)"
          },
          "cost_per_click": {
            "type": "number",
            "description": "Average cost per click"
          },
          "conversion_rate": {
            "type": "number",
            "description": "Conversion rate (%)"
          },
          "roas": {
            "type": "number",
            "description": "Return on Ad Spend"
          }
        }
      },
      "SellerHealthResponse": {
        "type": "object",
        "properties": {
          "channelId": {
            "type": "string",
            "example": "1"
          },
          "merchantId": {
            "type": "string",
            "example": "A1B2C3D4E5F6G7 @ ATVPDKIKX0DER"
          },
          "marketplace": {
            "type": "string",
            "description": "Marketplace type",
            "enum": [
              "amazon",
              "amazon_filtered",
              "ebay",
              "mirakl",
              "bol",
              "mercadolibre",
              "iconic"
            ]
          },
          "marketplaceSubtype": {
            "type": "string",
            "description": "Specific marketplace, same value as `marketplace` in POST /channels (for example `catch` or `bunnings` for Mirakl).",
            "example": "amazon"
          },
          "countryCode": {
            "type": "string",
            "description": "3-letter ISO country code.",
            "example": "USA"
          },
          "metrics": {
            "description": "Metric groups and keys differ by marketplace.",
            "oneOf": [
              {
                "$ref": "#/components/schemas/AmazonSellerHealthMetrics"
              },
              {
                "$ref": "#/components/schemas/EbaySellerHealthMetrics"
              },
              {
                "$ref": "#/components/schemas/MiraklSellerHealthMetrics"
              },
              {
                "$ref": "#/components/schemas/BolSellerHealthMetrics"
              },
              {
                "$ref": "#/components/schemas/MercadoLibreSellerHealthMetrics"
              },
              {
                "$ref": "#/components/schemas/IconicSellerHealthMetrics"
              }
            ]
          }
        }
      },
      "AmazonSellerHealthMetrics": {
        "title": "Amazon",
        "type": "object",
        "properties": {
          "accountHealth": {
            "type": "object",
            "properties": {
              "accountHealthRating": {
                "description": "Amazon Account Health Rating score. `value` is null when no score is provided. `status` is GOOD, AT_RISK, CRITICAL, NOT_ELIGIBLE, or null when not reported.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "inactiveListingsCount": {
                "description": "Inactive listings.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "listingIssuesCount": {
                "description": "Listings with issues.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "returnRequestsCount": {
                "description": "Return requests in the last 60 days, excluding approved returns.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "suppressedListingsCount": {
                "description": "Suppressed listings.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              }
            }
          },
          "shippingPerformance": {
            "type": "object",
            "properties": {
              "lateShipmentRate": {
                "description": "Late shipment rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "invoiceDefectRate": {
                "description": "Invoice defect rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "onTimeDeliveryRate": {
                "description": "On-time delivery rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "validTrackingRate": {
                "description": "Valid tracking rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "cancellationRate": {
                "description": "Pre-fulfillment cancellation rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              }
            }
          },
          "customerServiceFbm": {
            "type": "object",
            "properties": {
              "orderDefectRate": {
                "description": "Order defect rate, seller-fulfilled orders.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "negativeFeedbackCount": {
                "description": "Orders with negative feedback.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "chargebacksCount": {
                "description": "Credit card chargebacks.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "azClaimsCount": {
                "description": "A-to-z Guarantee claims.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              }
            }
          },
          "customerServiceFba": {
            "type": "object",
            "properties": {
              "orderDefectRate": {
                "description": "Order defect rate, Amazon-fulfilled orders.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "negativeFeedbackCount": {
                "description": "Orders with negative feedback.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "chargebacksCount": {
                "description": "Credit card chargebacks.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "azClaimsCount": {
                "description": "A-to-z Guarantee claims.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              }
            }
          },
          "policyCompliance": {
            "type": "object",
            "properties": {
              "ipComplaints": {
                "description": "Received intellectual property complaints.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "suspectedIpViolations": {
                "description": "Suspected intellectual property violations.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "listingPolicyViolations": {
                "description": "Listing policy violations.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "productAuthenticityComplaints": {
                "description": "Product authenticity customer complaints.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "productSafetyComplaints": {
                "description": "Product safety customer complaints.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "foodAndProductSafetyIssues": {
                "description": "Food and product safety issues.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "restrictedProductPolicyViolations": {
                "description": "Restricted product policy violations.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "otherPolicyViolations": {
                "description": "Other policy violations.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "productConditionCustomerComplaints": {
                "description": "Product condition customer complaints.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "productReviewPolicyViolations": {
                "description": "Customer product reviews policy violations.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "policyWarningsCount": {
                "description": "Policy violation warnings.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              }
            }
          }
        }
      },
      "SellerHealthNumberMetric": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SellerHealthMetricBase"
          },
          {
            "type": "object",
            "properties": {
              "value": {
                "type": "number",
                "nullable": true,
                "description": "Count or score. null or 0 when there is no data, depending on the marketplace.",
                "example": 2
              }
            }
          }
        ]
      },
      "SellerHealthMetricBase": {
        "type": "object",
        "properties": {
          "status": {
            "$ref": "#/components/schemas/SellerHealthStatus"
          },
          "target": {
            "$ref": "#/components/schemas/SellerHealthTarget"
          },
          "window": {
            "$ref": "#/components/schemas/SellerHealthWindow"
          }
        }
      },
      "SellerHealthStatus": {
        "type": "string",
        "nullable": true,
        "description": "Indicative health of the metric, derived by MerchantSpring from the marketplace's data and, where available, its thresholds; it may differ from the marketplace's own dashboard. `CRITICAL` and `NOT_ELIGIBLE` only apply to Amazon `accountHealthRating`. null when the metric is not assessed. Missing data may show as a null `value` or as 0 with a `status`, depending on the marketplace.",
        "enum": [
          "GOOD",
          "AT_RISK",
          "POOR",
          "CLOSED",
          "CRITICAL",
          "NOT_ELIGIBLE",
          null
        ]
      },
      "SellerHealthTarget": {
        "type": "object",
        "nullable": true,
        "description": "Threshold the status is assessed against, when available. 'Rate' targets are ratios, like `value`.",
        "properties": {
          "value": {
            "type": "number",
            "example": 0.04
          },
          "condition": {
            "type": "string",
            "enum": [
              "LESS_THAN",
              "GREATER_THAN",
              "EQUALS",
              "LESS_THAN_OR_EQUAL",
              "GREATER_THAN_OR_EQUAL"
            ]
          }
        }
      },
      "SellerHealthWindow": {
        "type": "object",
        "nullable": true,
        "description": "Period the metric covers, when available.",
        "properties": {
          "start": {
            "type": "string",
            "format": "date-time",
            "example": "2026-09-19T07:00:00Z"
          },
          "end": {
            "type": "string",
            "format": "date-time",
            "example": "2026-10-19T06:59:59Z"
          }
        }
      },
      "SellerHealthRateMetric": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SellerHealthMetricBase"
          },
          {
            "type": "object",
            "properties": {
              "value": {
                "type": "number",
                "nullable": true,
                "description": "Ratio between 0 and 1 (0.012 = 1.2%).",
                "example": 0.012
              },
              "numerator": {
                "type": "integer",
                "example": 3
              },
              "denominator": {
                "type": "integer",
                "example": 250
              }
            }
          }
        ]
      },
      "EbaySellerHealthMetrics": {
        "title": "eBay",
        "type": "object",
        "properties": {
          "accountHealth": {
            "type": "object",
            "properties": {
              "sellerLevel": {
                "description": "Current eBay seller level, for example TOP_RATED, ABOVE_STANDARD or BELOW_STANDARD.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthLevelMetric"
                  }
                ]
              },
              "projectedSellerLevel": {
                "description": "Projected seller level at the next evaluation.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthLevelMetric"
                  }
                ]
              }
            }
          },
          "shippingPerformance": {
            "type": "object",
            "properties": {
              "orderDefectRate": {
                "description": "Transaction defect rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "lateShipmentRate": {
                "description": "Late shipment rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "returnRequestsCount": {
                "description": "Return requests.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              }
            }
          },
          "resolutionCentre": {
            "type": "object",
            "properties": {
              "casesClosedWithoutResolutionRate": {
                "description": "Cases closed without seller resolution.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "casesCount": {
                "description": "Resolution centre cases.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "negativeFeedbackCount": {
                "description": "Negative feedback.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "newMessagesCount": {
                "description": "New messages.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              }
            }
          }
        }
      },
      "SellerHealthLevelMetric": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SellerHealthMetricBase"
          },
          {
            "type": "object",
            "properties": {
              "value": {
                "type": "string",
                "nullable": true,
                "description": "Health level as the marketplace names it. null when there is no data.",
                "example": "TOP_RATED"
              }
            }
          }
        ]
      },
      "MiraklSellerHealthMetrics": {
        "title": "Mirakl",
        "type": "object",
        "properties": {
          "accountHealth": {
            "type": "object",
            "properties": {
              "accountStatus": {
                "description": "Shop state, for example OPEN, SUSPENDED or CLOSE.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthLevelMetric"
                  }
                ]
              },
              "accountGrade": {
                "description": "Shop grade.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "approvalRate": {
                "description": "Order approval rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "messageThreadsCount": {
                "description": "Recent message threads.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "avgResponseTimeDays": {
                "description": "Average response time to customer messages, in days.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              }
            }
          }
        }
      },
      "BolSellerHealthMetrics": {
        "title": "Bol",
        "type": "object",
        "properties": {
          "shippingPerformance": {
            "type": "object",
            "properties": {
              "onTimeDeliveryRate": {
                "description": "Items delivered on time.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "validTrackingRate": {
                "description": "Items with valid track and trace.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "cancellationRate": {
                "description": "Seller-initiated cancellation rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "returnRate": {
                "description": "Return rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              }
            }
          },
          "customerService": {
            "type": "object",
            "properties": {
              "reviewScore": {
                "description": "Average review score.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "phoneAvailabilityRate": {
                "description": "Phone availability.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "supportCaseRate": {
                "description": "Customer service cases per order item.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "onTimeResponseRate": {
                "description": "Share of customer cases responded to within 24 working hours.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              }
            }
          }
        }
      },
      "MercadoLibreSellerHealthMetrics": {
        "title": "Mercado Libre",
        "type": "object",
        "properties": {
          "accountHealth": {
            "type": "object",
            "properties": {
              "powerSellerStatus": {
                "description": "MercadoLíder status, for example platinum, gold or silver.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthLevelMetric"
                  }
                ]
              },
              "realReputationLevel": {
                "description": "Reputation colour level.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthLevelMetric"
                  }
                ]
              },
              "protectionEndDate": {
                "description": "End of the reputation protection period.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthDateMetric"
                  }
                ]
              },
              "salesCount": {
                "description": "Completed sales in the window.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              }
            }
          },
          "reputation": {
            "type": "object",
            "properties": {
              "claimsRate": {
                "description": "Claims rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "cancellationRate": {
                "description": "Cancellation rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "delayedHandlingRate": {
                "description": "Delayed handling rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              }
            }
          },
          "ratings": {
            "type": "object",
            "properties": {
              "negativeRate": {
                "description": "Share of negative ratings.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "neutralRate": {
                "description": "Share of neutral ratings.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "positiveRate": {
                "description": "Share of positive ratings.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              }
            }
          }
        }
      },
      "SellerHealthDateMetric": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SellerHealthMetricBase"
          },
          {
            "type": "object",
            "properties": {
              "value": {
                "type": "string",
                "format": "date",
                "nullable": true,
                "description": "ISO date. null when there is no data.",
                "example": "2026-11-01"
              }
            }
          }
        ]
      },
      "IconicSellerHealthMetrics": {
        "title": "Iconic",
        "type": "object",
        "properties": {
          "accountHealth": {
            "type": "object",
            "properties": {
              "returnRate": {
                "description": "Return rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "cancellationRate": {
                "description": "Cancellation rate.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "shippedWithin48hRate": {
                "description": "Orders shipped within 2 days.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthRateMetric"
                  }
                ]
              },
              "soldOutProductsCount": {
                "description": "Products currently in Sold Out status.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "missingImageProductsCount": {
                "description": "Products currently in Image Missing status.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              },
              "poorQualityProductsCount": {
                "description": "Products currently in Poor Quality status.",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/SellerHealthNumberMetric"
                  }
                ]
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    }
  }
}
