UNPKG

@sp-api-sdk/schemas

Version:
200 lines (199 loc) 12.2 kB
import { type FromSchema } from 'json-schema-to-ts'; export declare const reportProcessingFinishedNotification: { readonly $id: "http://example.com/example.json"; readonly type: "object"; readonly description: "The root schema comprises the entire JSON document."; readonly examples: readonly [{ readonly notificationVersion: "2020-09-04"; readonly notificationType: "REPORT_PROCESSING_FINISHED"; readonly payloadVersion: "2020-09-04"; readonly eventTime: "2020-07-14T03:35:13.214Z"; readonly payload: { readonly reportProcessingFinishedNotification: { readonly sellerId: "A3TH9S8BH6GOGM"; readonly accountId: "amzn1.merchant.o.A3TH9S8BH6GOGM"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2020-07-13T19:42:04.284Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }, { readonly notificationVersion: "2020-09-04"; readonly notificationType: "REPORT_PROCESSING_FINISHED"; readonly payloadVersion: "2020-09-04"; readonly eventTime: "2020-07-14T03:35:13.214Z"; readonly payload: { readonly reportProcessingFinishedNotification: { readonly accountId: "amzn1.vg.6213651"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2020-07-13T19:42:04.284Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }; }]; readonly required: readonly ["notificationVersion", "notificationType", "payloadVersion", "eventTime", "payload", "notificationMetadata"]; readonly properties: { readonly notificationVersion: { readonly $id: "#/properties/notificationVersion"; readonly type: "string"; readonly description: "The version of the notification."; readonly examples: readonly ["2020-09-04"]; }; readonly notificationType: { readonly $id: "#/properties/notificationType"; readonly type: "string"; readonly description: "The type of the notification."; readonly examples: readonly ["REPORT_PROCESSING_FINISHED"]; }; readonly payloadVersion: { readonly $id: "#/properties/payloadVersion"; readonly type: "string"; readonly description: "The version of the payload."; readonly examples: readonly ["2020-09-04"]; }; readonly eventTime: { readonly $id: "#/properties/eventTime"; readonly type: "string"; readonly description: "The timestamp of the event, formatted as ISO 8601 date-time."; readonly examples: readonly ["2020-07-14T03:35:13.214Z"]; }; readonly payload: { readonly $id: "#/properties/payload"; readonly type: "object"; readonly description: "The details of this notification."; readonly examples: readonly [{ readonly reportProcessingFinishedNotification: { readonly sellerId: "A3TH9S8BH6GOGM"; readonly accountId: "amzn1.merchant.o.A3TH9S8BH6GOGM"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }; }, { readonly reportProcessingFinishedNotification: { readonly accountId: "amzn1.vg.6213651"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }; }]; readonly required: readonly ["reportProcessingFinishedNotification"]; readonly properties: { readonly reportProcessingFinishedNotification: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification"; readonly type: "object"; readonly description: "An explanation about the purpose of this instance."; readonly examples: readonly [{ readonly sellerId: "A3TH9S8BH6GOGM"; readonly accountId: "amzn1.merchant.o.A3TH9S8BH6GOGM"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }, { readonly accountId: "amzn1.vg.6213651"; readonly reportId: "54517018502"; readonly reportType: "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"; readonly processingStatus: "CANCELLED"; readonly reportDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"; }]; readonly required: readonly ["accountId", "reportId", "reportType", "processingStatus"]; readonly properties: { readonly sellerId: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/sellerId"; readonly type: "string"; readonly description: "The merchant customer identifier of the selling partner account on whose behalf the report was submitted. This field will be null when the report was submitted on behalf of a vendor group identifier."; readonly examples: readonly ["A3TH9S8BH6GOGM"]; }; readonly accountId: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/accountId"; readonly type: "string"; readonly description: "The merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the report was submitted."; readonly examples: readonly ["amzn1.merchant.o.A3TH9S8BH6GOGM", "amzn1.vg.6213651"]; }; readonly reportId: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportId"; readonly type: "string"; readonly description: "The report identifier."; readonly examples: readonly ["54517018502"]; }; readonly reportType: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportType"; readonly type: "string"; readonly description: "The report type."; readonly examples: readonly ["GET_FLAT_FILE_ACTIONABLE_ORDER_DATA"]; }; readonly processingStatus: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/processingStatus"; readonly type: "string"; readonly description: "The processing status of the report."; readonly examples: readonly ["CANCELLED", "DONE", "FATAL"]; readonly enum: readonly ["CANCELLED", "DONE", "FATAL"]; }; readonly reportDocumentId: { readonly $id: "#/properties/payload/properties/reportProcessingFinishedNotification/properties/reportDocumentId"; readonly type: "string"; readonly description: "The report document identifier. This identifier is unique only in combination with a seller ID."; readonly examples: readonly ["amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"]; }; }; }; }; }; readonly notificationMetadata: { readonly $id: "#/properties/notificationMetadata"; readonly type: "object"; readonly description: "The metadata of the notification."; readonly examples: readonly [{ readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2020-07-13T19:42:04.284Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["applicationId", "subscriptionId", "publishTime", "notificationId"]; readonly properties: { readonly applicationId: { readonly $id: "#/properties/notificationMetadata/properties/applicationId"; readonly type: "string"; readonly description: "The application identifier."; readonly examples: readonly ["amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"]; }; readonly subscriptionId: { readonly $id: "#/properties/notificationMetadata/properties/subscriptionId"; readonly type: "string"; readonly description: "The subscription identifier."; readonly examples: readonly ["subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly publishTime: { readonly $id: "#/properties/notificationMetadata/properties/publishTime"; readonly type: "string"; readonly description: "The timestamp of when the notification was published, formatted as ISO 8601 date-time."; readonly examples: readonly ["2020-07-13T19:42:04.284Z"]; }; readonly notificationId: { readonly $id: "#/properties/notificationMetadata/properties/notificationId"; readonly type: "string"; readonly description: "The notification identifier."; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; }; }; export type ReportProcessingFinishedNotification = FromSchema<typeof reportProcessingFinishedNotification>;