UNPKG

@sp-api-sdk/schemas

Version:

Selling Parner API additional schema types

github.com/bizon/selling-partner-api-sdk/tree/master/packages/notifications

bizon/selling-partner-api-sdk

203 lines (202 loc) • 10.4 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
import { type FromSchema } from 'json-schema-to-ts'; export declare const detailPageTrafficEventNotification: { readonly $id: "https://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: "DETAIL_PAGE_TRAFFIC_EVENT"; readonly payloadVersion: "2020-09-04"; readonly eventTime: "2023-02-07T16:05:32.378Z"; readonly payload: { readonly detailPageTrafficEvents: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly glanceViews: 42; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly glanceViews: 69; }]; }; readonly notificationMetadata: { readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2023-02-07T16:45:32.378Z"; 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 examples: readonly ["2020-09-04"]; }; readonly notificationType: { readonly $id: "#/properties/notificationType"; readonly type: "string"; readonly examples: readonly ["DETAIL_PAGE_TRAFFIC_EVENT"]; }; readonly payloadVersion: { readonly $id: "#/properties/payloadVersion"; readonly type: "string"; readonly examples: readonly ["2020-09-04"]; }; readonly eventTime: { readonly $id: "#/properties/eventTime"; readonly type: "string"; readonly examples: readonly ["2023-02-07T16:45:32.378Z"]; }; readonly payload: { readonly $id: "#/properties/payload"; readonly $ref: "#/definitions/Payload"; }; readonly notificationMetadata: { readonly $id: "#/properties/notificationMetadata"; readonly $ref: "#/definitions/NotificationMetadata"; }; }; readonly definitions: { readonly Payload: { readonly type: "object"; readonly examples: readonly [{ readonly detailPageTrafficEvents: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly glanceViews: 42; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly glanceViews: 69; }]; }]; readonly required: readonly ["detailPageTrafficEvents"]; readonly properties: { readonly detailPageTrafficEvents: { readonly $id: "#/definitions/Payload/properties/detailPageTrafficEvents"; readonly $ref: "#/definitions/DetailPageTrafficEvents"; }; }; }; readonly DetailPageTrafficEvents: { readonly type: "array"; readonly examples: readonly [readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly glanceViews: 42; }, { readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00094A20U"; readonly glanceViews: 69; }]]; readonly items: { readonly $ref: "#/definitions/DetailPageTrafficEvent"; }; }; readonly DetailPageTrafficEvent: { readonly type: "object"; readonly examples: readonly [{ readonly accountId: "amzn1.merchant.o.A21CXK3C4ERTY8"; readonly marketplaceId: "ATVPDKIKX0DER"; readonly startTime: "2023-02-07T15:00:00Z"; readonly endTime: "2023-02-07T16:00:00Z"; readonly asin: "B00032HE0O"; readonly glanceViews: 42; }]; readonly required: readonly ["accountId", "marketplaceId", "startTime", "endTime", "asin", "glanceViews"]; readonly properties: { readonly accountId: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/accountId"; readonly type: "string"; readonly description: "The merchant customer ID or vendor group ID of the partner account this notification is sent to."; readonly examples: readonly ["amzn1.merchant.o.A21CXK3C4ERTY8", "amzn1.vg.6213651"]; }; readonly marketplaceId: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/marketplaceId"; readonly type: "string"; readonly description: "The marketplace identifier of the traffic data."; readonly examples: readonly ["ATVPDKIKX0DER"]; }; readonly startTime: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/startTime"; readonly type: "string"; readonly format: "date-time"; readonly description: "The start of the date-time range of the traffic data in ISO 8601 format in UTC time."; readonly examples: readonly ["2023-02-07T15:00:00Z"]; }; readonly endTime: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/endTime"; readonly type: "string"; readonly format: "date-time"; readonly description: "The end of the date-time range of the traffic data in ISO 8601 format in UTC time."; readonly examples: readonly ["2023-02-07T16:00:00Z"]; }; readonly asin: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/asin"; readonly type: "string"; readonly description: "The Amazon Standard Identification Number of the product."; readonly examples: readonly ["B00032HE0O"]; }; readonly glanceViews: { readonly $id: "#/definitions/DetailPageTrafficEvent/properties/glanceViews"; readonly type: "integer"; readonly description: "The number of customer views of the product detail page for this ASIN."; readonly minimum: 0; readonly examples: readonly [42]; }; }; }; readonly NotificationMetadata: { readonly type: "object"; readonly examples: readonly [{ readonly applicationId: "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"; readonly subscriptionId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; readonly publishTime: "2023-02-07T16:45:32.378Z"; readonly notificationId: "d0e9e693-c3ad-4373-979f-ed4ec98dd746"; }]; readonly required: readonly ["applicationId", "subscriptionId", "publishTime", "notificationId"]; readonly properties: { readonly applicationId: { readonly $id: "#/definitions/NotificationMetadata/properties/applicationId"; readonly type: "string"; readonly examples: readonly ["amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336"]; }; readonly subscriptionId: { readonly $id: "#/definitions/NotificationMetadata/properties/subscriptionId"; readonly type: "string"; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; readonly publishTime: { readonly $id: "#/definitions/NotificationMetadata/properties/publishTime"; readonly type: "string"; readonly examples: readonly ["2023-02-07T16:45:32.378Z"]; }; readonly notificationId: { readonly $id: "#/definitions/NotificationMetadata/properties/notificationId"; readonly type: "string"; readonly examples: readonly ["d0e9e693-c3ad-4373-979f-ed4ec98dd746"]; }; }; }; }; }; export type DetailPageTrafficEventNotification = FromSchema<typeof detailPageTrafficEventNotification>;