Amazon Selling Partner API (SP-API) SDK for TypeScript
    Preparing search index...

    Variable taxInvoiceIssuanceEligibilityStatusChangeNotificationConst

    taxInvoiceIssuanceEligibilityStatusChangeNotification: {
        $ref: "#/definitions/Notification";
        definitions: {
            Notification: {
                properties: {
                    eventTime: {
                        description: "The date and time when the notification event occurred, in ISO 8601 format.";
                        type: "string";
                    };
                    notificationMetadata: {
                        $ref: "#/definitions/NotificationMetadata";
                        description: "The notification's metadata, including the publish time and the application, subscription, and notification event identifiers.";
                        type: "object";
                    };
                    notificationType: {
                        description: "The notification type.";
                        enum: readonly ["TAX_INVOICE_ISSUANCE_ELIGIBILITY_STATUS_CHANGE"];
                        type: "string";
                    };
                    notificationVersion: {
                        description: "The version for this notification type.";
                        type: "string";
                    };
                    payload: {
                        $ref: "#/definitions/Payload";
                        description: "Event details about the change to eligibility status.";
                        type: "object";
                    };
                    payloadVersion: {
                        description: "The version for this payload.";
                        type: "string";
                    };
                };
                required: readonly [
                    "notificationVersion",
                    "notificationType",
                    "payloadVersion",
                    "eventTime",
                    "payload",
                    "notificationMetadata",
                ];
                type: "object";
            };
            NotificationMetadata: {
                properties: {
                    applicationId: {
                        description: "The application identifier.";
                        type: "string";
                    };
                    notificationId: {
                        description: "The notification identifier.";
                        type: "string";
                    };
                    publishTime: {
                        description: "The date and time when the notification was published, in ISO 8601 format.";
                        type: "string";
                    };
                    subscriptionId: {
                        description: "The subscription identifier.";
                        type: "string";
                    };
                };
                required: readonly [
                    "applicationId",
                    "subscriptionId",
                    "publishTime",
                    "notificationId",
                ];
                type: "object";
            };
            Payload: {
                properties: {
                    marketplaceId: {
                        description: "The identifier for the store where the invoice issuance eligibility status applies.";
                        type: "string";
                    };
                    message: {
                        contains: {
                            properties: { locale: { const: "en-US" } };
                            required: readonly ["locale"];
                            type: "object";
                        };
                        description: "An optional message to describe why the operation is blocked.";
                        items: {
                            properties: {
                                locale: {
                                    description: "The language locale identifier in POSIX-style format.";
                                    enum: readonly ["en-US", "pt-BR", "es-MX"];
                                    type: "string";
                                };
                                text: {
                                    description: "The localized message text for the specified locale.";
                                    type: "string";
                                };
                            };
                            required: readonly ["locale", "text"];
                            type: "object";
                        };
                        minItems: 1;
                        type: "array";
                    };
                    operation: {
                        description: "The invoice issuance operation available to the seller.";
                        enum: readonly [
                            "inbound",
                            "outbound-fba-offers",
                            "c-returns",
                            "removals",
                        ];
                        type: "string";
                    };
                    status: {
                        description: "The status of the seller invoice issuance operation.";
                        enum: readonly ["BLOCKED", "ALLOWED"];
                        type: "string";
                    };
                };
                required: readonly ["marketplaceId", "operation", "status"];
                type: "object";
            };
        };
        description: "The response schema for notifications sent when a tax invoice issuance eligibility status changes.";
        type: "object";
    } = ...

    Type Declaration

    • Readonly$ref: "#/definitions/Notification"
    • Readonlydefinitions: {
          Notification: {
              properties: {
                  eventTime: {
                      description: "The date and time when the notification event occurred, in ISO 8601 format.";
                      type: "string";
                  };
                  notificationMetadata: {
                      $ref: "#/definitions/NotificationMetadata";
                      description: "The notification's metadata, including the publish time and the application, subscription, and notification event identifiers.";
                      type: "object";
                  };
                  notificationType: {
                      description: "The notification type.";
                      enum: readonly ["TAX_INVOICE_ISSUANCE_ELIGIBILITY_STATUS_CHANGE"];
                      type: "string";
                  };
                  notificationVersion: {
                      description: "The version for this notification type.";
                      type: "string";
                  };
                  payload: {
                      $ref: "#/definitions/Payload";
                      description: "Event details about the change to eligibility status.";
                      type: "object";
                  };
                  payloadVersion: {
                      description: "The version for this payload.";
                      type: "string";
                  };
              };
              required: readonly [
                  "notificationVersion",
                  "notificationType",
                  "payloadVersion",
                  "eventTime",
                  "payload",
                  "notificationMetadata",
              ];
              type: "object";
          };
          NotificationMetadata: {
              properties: {
                  applicationId: {
                      description: "The application identifier.";
                      type: "string";
                  };
                  notificationId: {
                      description: "The notification identifier.";
                      type: "string";
                  };
                  publishTime: {
                      description: "The date and time when the notification was published, in ISO 8601 format.";
                      type: "string";
                  };
                  subscriptionId: {
                      description: "The subscription identifier.";
                      type: "string";
                  };
              };
              required: readonly [
                  "applicationId",
                  "subscriptionId",
                  "publishTime",
                  "notificationId",
              ];
              type: "object";
          };
          Payload: {
              properties: {
                  marketplaceId: {
                      description: "The identifier for the store where the invoice issuance eligibility status applies.";
                      type: "string";
                  };
                  message: {
                      contains: {
                          properties: { locale: { const: "en-US" } };
                          required: readonly ["locale"];
                          type: "object";
                      };
                      description: "An optional message to describe why the operation is blocked.";
                      items: {
                          properties: {
                              locale: {
                                  description: "The language locale identifier in POSIX-style format.";
                                  enum: readonly ["en-US", "pt-BR", "es-MX"];
                                  type: "string";
                              };
                              text: {
                                  description: "The localized message text for the specified locale.";
                                  type: "string";
                              };
                          };
                          required: readonly ["locale", "text"];
                          type: "object";
                      };
                      minItems: 1;
                      type: "array";
                  };
                  operation: {
                      description: "The invoice issuance operation available to the seller.";
                      enum: readonly [
                          "inbound",
                          "outbound-fba-offers",
                          "c-returns",
                          "removals",
                      ];
                      type: "string";
                  };
                  status: {
                      description: "The status of the seller invoice issuance operation.";
                      enum: readonly ["BLOCKED", "ALLOWED"];
                      type: "string";
                  };
              };
              required: readonly ["marketplaceId", "operation", "status"];
              type: "object";
          };
      }
    • Readonlydescription: "The response schema for notifications sent when a tax invoice issuance eligibility status changes."
    • Readonlytype: "object"