@sp-api-sdk/schemas
Version:
Selling Parner API additional schema types
188 lines (187 loc) • 12.8 kB
TypeScript
import { type FromSchema } from 'json-schema-to-ts';
export declare const dataKioskQueryProcessingFinishedNotification: {
readonly type: "object";
readonly title: "Data Kiosk Query Processing Finished Notification.";
readonly description: "This notification is delivered when a Data Kiosk query finishes processing.";
readonly examples: readonly [{
readonly notificationVersion: "2023-11-15";
readonly notificationType: "DATA_KIOSK_QUERY_PROCESSING_FINISHED";
readonly payloadVersion: "2023-11-15";
readonly eventTime: "2023-12-23T21:30:13.713Z";
readonly payload: {
readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
readonly queryId: "54517018502";
readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
readonly processingStatus: "DONE";
readonly dataDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ";
readonly pagination: {
readonly nextToken: "AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz";
};
};
readonly notificationMetadata: {
readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336";
readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
readonly publishTime: "2023-12-23T21:30:16.903Z";
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 notification version.";
readonly examples: readonly ["2023-11-15"];
};
readonly notificationType: {
readonly $id: "#/properties/notificationType";
readonly type: "string";
readonly description: "The notification type.";
readonly examples: readonly ["DATA_KIOSK_QUERY_PROCESSING_FINISHED"];
};
readonly payloadVersion: {
readonly $id: "#/properties/payloadVersion";
readonly type: "string";
readonly description: "The payload version of the notification.";
readonly examples: readonly ["2023-11-15"];
};
readonly eventTime: {
readonly $id: "#/properties/eventTime";
readonly type: "string";
readonly description: "The time the notification was sent in ISO 8601 format.";
readonly examples: readonly ["2023-12-23T21:30:13.713Z"];
};
readonly payload: {
readonly $id: "#/properties/payload";
readonly type: "object";
readonly description: "The Data Kiosk query processing notification payload.";
readonly examples: readonly [{
readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
readonly queryId: "54517018502";
readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
readonly processingStatus: "DONE";
readonly dataDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ";
readonly pagination: {
readonly nextToken: "AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz";
};
}, {
readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
readonly queryId: "54517018502";
readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
readonly processingStatus: "DONE";
readonly dataDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ";
}, {
readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
readonly queryId: "54517018502";
readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
readonly processingStatus: "DONE";
}, {
readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
readonly queryId: "54517018502";
readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
readonly processingStatus: "CANCELLED";
}, {
readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8";
readonly queryId: "54517018502";
readonly query: "query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}";
readonly processingStatus: "FATAL";
readonly errorDocumentId: "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ";
}];
readonly required: readonly ["accountId", "queryId", "query", "processingStatus"];
readonly properties: {
readonly accountId: {
readonly $id: "#/properties/payload/properties/accountId";
readonly type: "string";
readonly description: "The merchant customer identifier or vendor group identifier of the selling partner account on whose behalf the query was submitted.";
readonly examples: readonly ["amzn1.merchant.o.A21CXK3C4ERTY8", "amzn1.vg.6213651"];
};
readonly queryId: {
readonly $id: "#/properties/payload/properties/queryId";
readonly type: "string";
readonly description: "The query identifier. This identifier is unique only in combination with the `accountId`.";
readonly examples: readonly ["54517018502"];
};
readonly query: {
readonly $id: "#/properties/payload/properties/query";
readonly type: "string";
readonly description: "The submitted query.";
readonly examples: readonly ["query MyQuery{salesAndTrafficByDate(startDate:\"2023-05-01\" endDate:\"2023-06-01\" aggregateBy:DAY){marketplaceId startDate endDate sales{unitsOrdered}traffic{pageViews}}}"];
};
readonly processingStatus: {
readonly $id: "#/properties/payload/properties/processingStatus";
readonly type: "string";
readonly description: "The processing status of the query.";
readonly examples: readonly ["CANCELLED", "DONE", "FATAL"];
readonly enum: readonly ["CANCELLED", "DONE", "FATAL"];
};
readonly dataDocumentId: {
readonly $id: "#/properties/payload/properties/dataDocumentId";
readonly type: "string";
readonly description: "The data document identifier. This document identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with the `accountId`. Pass this identifier into the `getDocument` operation to get the information required to retrieve the data document's contents.";
readonly examples: readonly ["amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"];
};
readonly errorDocumentId: {
readonly $id: "#/properties/payload/properties/errorDocumentId";
readonly type: "string";
readonly description: "The error document identifier. This document identifier is only present when an error occurs during query processing. This identifier is unique only in combination with the `accountId`. Pass this identifier into the `getDocument` operation to get the information required to retrieve the error document's contents.";
readonly examples: readonly ["amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"];
};
readonly pagination: {
readonly $id: "#/properties/payload/properties/pagination";
readonly type: "object";
readonly description: "When a query produces results that are not included in the data document, pagination occurs. This means that results are divided into pages. To retrieve the next page, you must pass a `CreateQuerySpecification` object with `paginationToken` set to this object's `nextToken` and with `query` set to this object's `query` in the subsequent `createQuery` request. When there are no more pages to fetch, the `nextToken` field will be absent.";
readonly examples: readonly [{
readonly nextToken: "AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz";
}];
readonly properties: {
readonly nextToken: {
readonly $id: "#/properties/payload/properties/pagination/properties/nextToken";
readonly type: "string";
readonly description: "A token that can be used to fetch the next page of results.";
readonly examples: readonly ["AAMA-EFRSURBSGhKZlpVSWVwOW96aU1xa2p6amVJdGp1YlZxMndOelFXa2hydStrUjZvVmFRRWVINldMNnFUVz"];
};
};
};
};
};
readonly notificationMetadata: {
readonly $id: "#/properties/notificationMetadata";
readonly type: "object";
readonly description: "The notification's metadata.";
readonly examples: readonly [{
readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336";
readonly subscriptionId: "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746";
readonly publishTime: "2023-12-23T21:30:16.903Z";
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 time the notification was published in ISO 8601 format.";
readonly examples: readonly ["2023-12-23T21:30:16.903Z"];
};
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 DataKioskQueryProcessingFinishedNotification = FromSchema<typeof dataKioskQueryProcessingFinishedNotification>;