listingsFeedProcessingReportSchemaV2: {
    $comment: "JSON Schema describing the document format for JSON Selling Partner Listings Feeds Processing Report (v2).";
    properties: {
        header: {
            description: "Header information about the feed submission.";
            properties: {
                feedId: {
                    description: "The identifier for the feed. This identifier is unique only in combination with a seller ID.";
                    title: "Feed Identifier";
                    type: "string";
                };
                sellerId: {
                    description: "Identifier for the Selling Partner, such as the Merchant Account or Vendor Code.";
                    title: "Selling Partner Identifier";
                    type: "string";
                };
                version: {
                    const: "2.0";
                    description: "Version of the JSON Selling Partner Listings Feeds specification used for the feed submission.";
                    title: "Feed Version";
                    type: "string";
                };
            };
            required: readonly ["sellerId", "version", "feedId"];
            title: "Processing Report Header";
            type: "object";
        };
        issues: {
            description: "Issues containing message processing information for the Selling Partner.";
            items: {
                description: "Issue containing message processing information corresponding to an individual listings data submission.";
                properties: {
                    attributeName: {
                        description: "Name of the attribute associated with the issue, if applicable.";
                        examples: readonly ["item_type_name"];
                        type: "string";
                    };
                    code: {
                        description: "An Optional error code that maps to documentation.";
                        examples: readonly ["ABC123"];
                        minLength: 1;
                        title: "Error Code";
                        type: "string";
                    };
                    message: {
                        description: "Localized Error Message Associated with the issue encountered.";
                        examples: readonly [
                            "'[batteries_required]' is required but not supplied.",
                        ];
                        minLength: 1;
                        title: "Localized Error Message";
                        type: "string";
                    };
                    messageId: {
                        description: "Identifier for the message that is unique within this feed submission. Correlated to Identifiers provided in the submitted feed. Not provided if the error is not related to a message (e.g. feed formatting issue).";
                        examples: readonly [1];
                        minimum: 1;
                        title: "Message Identifier";
                        type: "integer";
                    };
                    severity: {
                        description: "The severity of the issue.";
                        enum: readonly ["ERROR", "WARNING", "INFO"];
                        title: "Error Severity";
                        type: "string";
                    };
                };
                required: readonly ["severity", "message"];
                title: "Issue";
                type: "object";
            };
            minItems: 0;
            title: "Issues Encountered Processing Messages";
            type: "array";
        };
        summary: {
            description: "Aggregate Count of Errors, Warnings, and the status of message submissions.";
            properties: {
                errors: {
                    description: "Number of errors encountered processing the feed.";
                    examples: readonly [1];
                    minimum: 0;
                    title: "Errors";
                    type: "integer";
                };
                messagesAccepted: {
                    description: "Number of messages that were accepted, the associated updates are being applied.";
                    examples: readonly [1];
                    minimum: 0;
                    title: "Messages Accepted";
                    type: "integer";
                };
                messagesInvalid: {
                    description: "Number of messages that were invalid, the associated updates will not be applied.";
                    examples: readonly [1];
                    minimum: 0;
                    title: "Messages Invalid";
                    type: "integer";
                };
                messagesProcessed: {
                    description: "Number of messages processed.";
                    examples: readonly [1];
                    minimum: 0;
                    title: "Messages Processed";
                    type: "integer";
                };
                warnings: {
                    description: "Number of warnings encountered processing the feed.";
                    examples: readonly [1];
                    minimum: 0;
                    title: "Warnings";
                    type: "integer";
                };
            };
            required: readonly [
                "errors",
                "warnings",
                "messagesProcessed",
                "messagesAccepted",
                "messagesInvalid",
            ];
            title: "Processing Report Summary";
            type: "object";
        };
    };
    required: readonly ["header", "issues", "summary"];
    title: "Selling Partner JSON Listings Feed Processing Report (v2)";
    type: "object";
} = ...

Type declaration

  • Readonly$comment: "JSON Schema describing the document format for JSON Selling Partner Listings Feeds Processing Report (v2)."
  • Readonlyproperties: {
        header: {
            description: "Header information about the feed submission.";
            properties: {
                feedId: {
                    description: "The identifier for the feed. This identifier is unique only in combination with a seller ID.";
                    title: "Feed Identifier";
                    type: "string";
                };
                sellerId: {
                    description: "Identifier for the Selling Partner, such as the Merchant Account or Vendor Code.";
                    title: "Selling Partner Identifier";
                    type: "string";
                };
                version: {
                    const: "2.0";
                    description: "Version of the JSON Selling Partner Listings Feeds specification used for the feed submission.";
                    title: "Feed Version";
                    type: "string";
                };
            };
            required: readonly ["sellerId", "version", "feedId"];
            title: "Processing Report Header";
            type: "object";
        };
        issues: {
            description: "Issues containing message processing information for the Selling Partner.";
            items: {
                description: "Issue containing message processing information corresponding to an individual listings data submission.";
                properties: {
                    attributeName: {
                        description: "Name of the attribute associated with the issue, if applicable.";
                        examples: readonly ["item_type_name"];
                        type: "string";
                    };
                    code: {
                        description: "An Optional error code that maps to documentation.";
                        examples: readonly ["ABC123"];
                        minLength: 1;
                        title: "Error Code";
                        type: "string";
                    };
                    message: {
                        description: "Localized Error Message Associated with the issue encountered.";
                        examples: readonly [
                            "'[batteries_required]' is required but not supplied.",
                        ];
                        minLength: 1;
                        title: "Localized Error Message";
                        type: "string";
                    };
                    messageId: {
                        description: "Identifier for the message that is unique within this feed submission. Correlated to Identifiers provided in the submitted feed. Not provided if the error is not related to a message (e.g. feed formatting issue).";
                        examples: readonly [1];
                        minimum: 1;
                        title: "Message Identifier";
                        type: "integer";
                    };
                    severity: {
                        description: "The severity of the issue.";
                        enum: readonly ["ERROR", "WARNING", "INFO"];
                        title: "Error Severity";
                        type: "string";
                    };
                };
                required: readonly ["severity", "message"];
                title: "Issue";
                type: "object";
            };
            minItems: 0;
            title: "Issues Encountered Processing Messages";
            type: "array";
        };
        summary: {
            description: "Aggregate Count of Errors, Warnings, and the status of message submissions.";
            properties: {
                errors: {
                    description: "Number of errors encountered processing the feed.";
                    examples: readonly [1];
                    minimum: 0;
                    title: "Errors";
                    type: "integer";
                };
                messagesAccepted: {
                    description: "Number of messages that were accepted, the associated updates are being applied.";
                    examples: readonly [1];
                    minimum: 0;
                    title: "Messages Accepted";
                    type: "integer";
                };
                messagesInvalid: {
                    description: "Number of messages that were invalid, the associated updates will not be applied.";
                    examples: readonly [1];
                    minimum: 0;
                    title: "Messages Invalid";
                    type: "integer";
                };
                messagesProcessed: {
                    description: "Number of messages processed.";
                    examples: readonly [1];
                    minimum: 0;
                    title: "Messages Processed";
                    type: "integer";
                };
                warnings: {
                    description: "Number of warnings encountered processing the feed.";
                    examples: readonly [1];
                    minimum: 0;
                    title: "Warnings";
                    type: "integer";
                };
            };
            required: readonly [
                "errors",
                "warnings",
                "messagesProcessed",
                "messagesAccepted",
                "messagesInvalid",
            ];
            title: "Processing Report Summary";
            type: "object";
        };
    }
  • Readonlyrequired: readonly ["header", "issues", "summary"]
  • Readonlytitle: "Selling Partner JSON Listings Feed Processing Report (v2)"
  • Readonlytype: "object"