Variable listingsFeedProcessingReportSchemaV2Const

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";
              };
              report: {
                  description: "The report information for the feed submission.";
                  properties: {
                      apiVersion: {
                          description: "The version of the Selling Partner Listings Items API to use to retrieve the listing items.";
                          enum: readonly ["2021-08-01"];
                          title: "Selling Partner Listings Items API Version";
                          type: "string";
                      };
                      includedData: {
                          description: "When \"includedData\" elements are in the feed submission, the processing report that generates for the feed submission includes the listings items output from the Selling Partner Listings Items API with the \"includedData\" elements from the request. The report includes issues that prevent the acceptance of messages regardless of the \"includedData\" elements in the feed request.";
                          items: {
                              enum: readonly [
                                  "summaries",
                                  "attributes",
                                  "issues",
                                  "offers",
                                  "fulfillmentAvailability",
                                  "procurement",
                                  "relationships",
                                  "productTypes",
                              ];
                              type: "string";
                          };
                          minItems: 1;
                          title: "Included Data";
                          type: "array";
                      };
                  };
                  required: readonly ["includedData", "apiVersion"];
                  title: "Report";
                  type: "object";
              };
              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";
      };
      items: {
          description: "A set of listings items and their specific data sets that originates from the feed request’s \"includedData\" header parameter.";
          items: {
              additionalProperties: true;
              description: "A listings item.";
              minProperties: 1;
              title: "Item";
              type: "object";
          };
          title: "Listings Items";
          type: "array";
      };
      summary: {
          description: "Aggregate counts of errors, warnings, and statuses related to the acceptance of feed messages. When requested, Item Summary includes aggregate counts of items, errors, and warnings related to the listing items created or updated by this feed submission.";
          properties: {
              errors: {
                  description: "Number of errors encountered processing the feed.";
                  examples: readonly [1];
                  minimum: 0;
                  title: "Errors";
                  type: "integer";
              };
              itemSummary: {
                  description: "Aggregate counts of items, errors, and warnings related to the listing items created or updated by this feed submission and included in the Items section of this report.";
                  properties: {
                      errors: {
                          description: "Number of errors across all listing items created or updated by this feed submission.";
                          examples: readonly [1];
                          minimum: 0;
                          title: "Errors";
                          type: "integer";
                      };
                      items: {
                          description: "Number of listing items created or updated by this feed submission and included in the Items section of this report.";
                          examples: readonly [1];
                          minimum: 0;
                          title: "Items";
                          type: "integer";
                      };
                      warnings: {
                          description: "Number of warnings across all listing items created or updated by this feed submission.";
                          examples: readonly [1];
                          minimum: 0;
                          title: "Warnings";
                          type: "integer";
                      };
                  };
                  required: readonly ["items", "errors", "warnings"];
                  title: "Item Summary";
                  type: "object";
              };
              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"