@restorecommerce/protos 6.11.1 → 6.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/io/restorecommerce/country.proto +3 -1
- package/io/restorecommerce/file.proto +14 -5
- package/io/restorecommerce/fulfillment.proto +57 -28
- package/io/restorecommerce/fulfillment_courier.proto +9 -4
- package/io/restorecommerce/product.proto +44 -2
- package/io/restorecommerce/resource_base.proto +1 -0
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,19 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [6.11.2](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.11.1...@restorecommerce/protos@6.11.2) (2025-05-14)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **protos:** add collection (name) to message Deleted for kafka DeletedAll event ([807ca4c](https://github.com/restorecommerce/libs/commit/807ca4cce3624720c6a2436afdee407ec181029c))
|
|
12
|
+
* **protos:** add costums declaration to fulfillment ([0797faa](https://github.com/restorecommerce/libs/commit/0797faa53388cbc81340203d58c92340f7443514))
|
|
13
|
+
* **protos:** fix typos in proto, load meta in acs decorater, refactor logger filePath detector ([8f02eee](https://github.com/restorecommerce/libs/commit/8f02eee6460b9c48f2f8416b08017f6ba11caf4e))
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
6
19
|
## [6.11.1](https://github.com/restorecommerce/libs/compare/@restorecommerce/protos@6.11.0...@restorecommerce/protos@6.11.1) (2025-03-31)
|
|
7
20
|
|
|
8
21
|
|
|
@@ -46,7 +46,9 @@ message Country {
|
|
|
46
46
|
optional string id = 1;
|
|
47
47
|
optional io.restorecommerce.meta.Meta meta = 2;
|
|
48
48
|
optional string name = 3;
|
|
49
|
-
optional string country_code = 4;
|
|
49
|
+
optional string country_code = 4; // primaly used in target application (fallback)
|
|
50
50
|
optional string geographical_name = 5;
|
|
51
51
|
repeated string economic_areas = 6;
|
|
52
|
+
optional string country_code_alpha_2 = 7; // ISO 3166-1 alpha-2
|
|
53
|
+
optional string country_code_alpha_3 = 8; // ISO 3166-1 alpha-3
|
|
52
54
|
}
|
|
@@ -4,19 +4,28 @@ package io.restorecommerce.file;
|
|
|
4
4
|
|
|
5
5
|
import "io/restorecommerce/image.proto";
|
|
6
6
|
|
|
7
|
+
message Blob {
|
|
8
|
+
bytes data = 1;
|
|
9
|
+
string encoding = 2;
|
|
10
|
+
}
|
|
11
|
+
|
|
7
12
|
message File {
|
|
8
13
|
optional string id = 1;
|
|
9
14
|
optional uint32 ordinal = 2;
|
|
10
15
|
optional string caption = 3;
|
|
11
16
|
optional string filename = 4;
|
|
12
17
|
optional string content_type = 5;
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
18
|
+
oneof type {
|
|
19
|
+
string url = 6;
|
|
20
|
+
Blob blob = 7;
|
|
21
|
+
}
|
|
22
|
+
optional int64 bytes = 8;
|
|
23
|
+
repeated string tags = 9;
|
|
24
|
+
optional io.restorecommerce.image.Image thumbnail = 10;
|
|
17
25
|
}
|
|
18
26
|
|
|
19
27
|
message FileList {
|
|
20
28
|
repeated File items = 1;
|
|
21
29
|
optional uint32 total_count = 2;
|
|
22
|
-
}
|
|
30
|
+
}
|
|
31
|
+
|
|
@@ -9,12 +9,12 @@ import "io/restorecommerce/auth.proto";
|
|
|
9
9
|
import "io/restorecommerce/status.proto";
|
|
10
10
|
import "io/restorecommerce/meta.proto";
|
|
11
11
|
import "io/restorecommerce/address.proto";
|
|
12
|
-
import "io/restorecommerce/country.proto";
|
|
13
12
|
import "io/restorecommerce/product.proto";
|
|
14
13
|
import "io/restorecommerce/options.proto";
|
|
15
14
|
import "io/restorecommerce/price.proto";
|
|
16
15
|
import "io/restorecommerce/amount.proto";
|
|
17
16
|
import "io/restorecommerce/invoice.proto";
|
|
17
|
+
import "io/restorecommerce/file.proto";
|
|
18
18
|
import "google/protobuf/timestamp.proto";
|
|
19
19
|
|
|
20
20
|
// Used by resolvers
|
|
@@ -91,26 +91,41 @@ service FulfillmentService {
|
|
|
91
91
|
|
|
92
92
|
enum FulfillmentState {
|
|
93
93
|
PENDING = 0;
|
|
94
|
-
SUBMITTED =
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
94
|
+
SUBMITTED = 1;
|
|
95
|
+
IN_TRANSIT = 2;
|
|
96
|
+
COMPLETE = 3;
|
|
97
|
+
CANCELLED = 4;
|
|
98
|
+
WITHDRAWN = 5;
|
|
99
|
+
RETOURE = 6;
|
|
100
|
+
RETOURE_COMPLETE = 7;
|
|
101
|
+
FAILED = 8;
|
|
102
|
+
INVALID = 9;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
enum ExportType {
|
|
106
|
+
OTHER = 0;
|
|
107
|
+
PRESENT = 1;
|
|
108
|
+
COMMERCIAL_SAMPLE = 2;
|
|
109
|
+
DOCUMENT = 3;
|
|
110
|
+
RETURN_OF_GOODS = 4;
|
|
111
|
+
COMMERCIAL_GOODS = 5;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
enum ShippingCondition {
|
|
115
|
+
DDU = 0;
|
|
116
|
+
DPA = 1;
|
|
117
|
+
DAP = 2;
|
|
118
|
+
DDP = 3;
|
|
119
|
+
DDX = 4;
|
|
120
|
+
DXV = 5;
|
|
107
121
|
}
|
|
108
122
|
|
|
109
123
|
message Item {
|
|
110
124
|
optional string product_id = 1;
|
|
111
125
|
optional string variant_id = 2;
|
|
112
126
|
optional int32 quantity = 3;
|
|
113
|
-
optional
|
|
127
|
+
optional string harmonizedSystemCode = 4;
|
|
128
|
+
optional io.restorecommerce.amount.Amount amount = 5;
|
|
114
129
|
}
|
|
115
130
|
|
|
116
131
|
message Parcel {
|
|
@@ -128,19 +143,35 @@ message Parcel {
|
|
|
128
143
|
repeated Item items = 4;
|
|
129
144
|
optional io.restorecommerce.price.Price price = 5;
|
|
130
145
|
optional io.restorecommerce.amount.Amount amount = 6;
|
|
131
|
-
optional io.restorecommerce.product.Package package =
|
|
146
|
+
optional io.restorecommerce.product.Package package = 7;
|
|
132
147
|
}
|
|
133
148
|
|
|
134
149
|
message Label {
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
optional
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
150
|
+
optional string id = 1;
|
|
151
|
+
optional string parcel_id = 2;
|
|
152
|
+
optional io.restorecommerce.file.File file = 3;
|
|
153
|
+
optional string shipment_number = 4; //filled on Order
|
|
154
|
+
optional FulfillmentState state = 5; //update by Track
|
|
155
|
+
optional io.restorecommerce.status.Status status = 6; //API status
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
message Charge {
|
|
159
|
+
optional string description = 1;
|
|
160
|
+
optional io.restorecommerce.amount.Amount charge = 2;
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
message CustomsDeclaration {
|
|
164
|
+
optional string export_type = 1; // should be ExportType (but unconstrained)
|
|
165
|
+
optional string export_description = 2;
|
|
166
|
+
optional string invoice_number = 3;
|
|
167
|
+
optional string consignee_ref = 4;
|
|
168
|
+
optional string shipper_ref = 5;
|
|
169
|
+
optional string MRN = 6;
|
|
170
|
+
optional string permit_number = 7; // for e.g. rare goods
|
|
171
|
+
optional string attestation = 8; // for e.g. medical goods
|
|
172
|
+
optional string shipping_condition = 9; // should be ShippingCondition (unconstrained)
|
|
173
|
+
repeated Charge charges = 10;
|
|
174
|
+
optional bool notify = 11;
|
|
144
175
|
}
|
|
145
176
|
|
|
146
177
|
message Packaging {
|
|
@@ -148,9 +179,7 @@ message Packaging {
|
|
|
148
179
|
optional io.restorecommerce.address.ShippingAddress sender = 2;
|
|
149
180
|
optional io.restorecommerce.address.ShippingAddress recipient = 3;
|
|
150
181
|
optional string notify = 4;
|
|
151
|
-
optional
|
|
152
|
-
optional string export_description = 6;
|
|
153
|
-
optional string invoice_number = 7;
|
|
182
|
+
optional CustomsDeclaration customs_declaration = 5;
|
|
154
183
|
}
|
|
155
184
|
|
|
156
185
|
message Event {
|
|
@@ -6,6 +6,7 @@ import "google/protobuf/any.proto";
|
|
|
6
6
|
import "io/restorecommerce/resource_base.proto";
|
|
7
7
|
import "io/restorecommerce/meta.proto";
|
|
8
8
|
import "io/restorecommerce/auth.proto";
|
|
9
|
+
import "io/restorecommerce/attribute.proto";
|
|
9
10
|
import "io/restorecommerce/status.proto";
|
|
10
11
|
import "io/restorecommerce/options.proto";
|
|
11
12
|
|
|
@@ -26,6 +27,10 @@ service FulfillmentCourierService {
|
|
|
26
27
|
rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
|
|
27
28
|
}
|
|
28
29
|
|
|
30
|
+
enum SupportedAPI {
|
|
31
|
+
DHLRest = 0;
|
|
32
|
+
}
|
|
33
|
+
|
|
29
34
|
message FulfillmentCourier {
|
|
30
35
|
option (restorecommerce.options.kafka_subscriber) = {
|
|
31
36
|
plural: "fulfillmentCouriers"
|
|
@@ -50,10 +55,10 @@ message FulfillmentCourier {
|
|
|
50
55
|
optional string description = 5;
|
|
51
56
|
optional string logo = 6;
|
|
52
57
|
optional string website = 7;
|
|
53
|
-
optional string
|
|
54
|
-
optional
|
|
55
|
-
optional
|
|
56
|
-
|
|
58
|
+
optional string credential_id = 8;
|
|
59
|
+
optional google.protobuf.Any configuration = 9;
|
|
60
|
+
optional string api = 10; // should be SupportedAPI (but unconstrained)
|
|
61
|
+
repeated io.restorecommerce.attribute.Attribute attributes = 11;
|
|
57
62
|
}
|
|
58
63
|
|
|
59
64
|
message FulfillmentCourierList {
|
|
@@ -33,9 +33,35 @@ service ProductService {
|
|
|
33
33
|
rpc Update (ProductList) returns (ProductListResponse);
|
|
34
34
|
rpc Upsert (ProductList) returns (ProductListResponse);
|
|
35
35
|
|
|
36
|
+
/*
|
|
37
|
+
* Response with resolved product-variants in a flatten message
|
|
38
|
+
*/
|
|
36
39
|
rpc GetVariant (IndividualProductVariantListRequest) returns (IndividualProductVariantListResponse) {
|
|
37
40
|
option (io.restorecommerce.options.is_query) = true;
|
|
38
41
|
};
|
|
42
|
+
|
|
43
|
+
/*
|
|
44
|
+
* Response with resolved product-variants
|
|
45
|
+
* Claims a requested quantity from stock level permanently.
|
|
46
|
+
* Response with an error status if requested quantity is not in stock.
|
|
47
|
+
*/
|
|
48
|
+
rpc ClaimVariant (IndividualProductVariantListRequest) returns (IndividualProductVariantListResponse);
|
|
49
|
+
|
|
50
|
+
/*
|
|
51
|
+
* Response with resolved product-variants
|
|
52
|
+
* Releases a requested quantity back to stock level.
|
|
53
|
+
*/
|
|
54
|
+
rpc ReleaseVariant (IndividualProductVariantListRequest) returns (IndividualProductVariantListResponse);
|
|
55
|
+
|
|
56
|
+
/*
|
|
57
|
+
* Claim all products assigned to a session permanently
|
|
58
|
+
*/
|
|
59
|
+
rpc ResolveSession (Session) returns (IndividualProductVariantListResponse);
|
|
60
|
+
|
|
61
|
+
/*
|
|
62
|
+
* Drop session and instantly release all claimed products
|
|
63
|
+
*/
|
|
64
|
+
rpc DropSession (Session) returns (IndividualProductVariantListResponse);
|
|
39
65
|
}
|
|
40
66
|
|
|
41
67
|
enum AssociationType {
|
|
@@ -262,9 +288,24 @@ message BundleProduct {
|
|
|
262
288
|
optional double price_ratio = 4; //Price ratio in relation to the bundle price
|
|
263
289
|
}
|
|
264
290
|
|
|
291
|
+
message Session {
|
|
292
|
+
optional string id = 1; // get a new id if empty
|
|
293
|
+
optional google.protobuf.Timestamp from = 2; // required field to start a session
|
|
294
|
+
optional google.protobuf.Timestamp to = 3; // leave empty for auto max session
|
|
295
|
+
}
|
|
296
|
+
|
|
265
297
|
message IndividualProductVariantRequest {
|
|
298
|
+
message Localization {
|
|
299
|
+
optional string country_id = 1;
|
|
300
|
+
optional string locale_id = 2;
|
|
301
|
+
optional string currency_id = 3;
|
|
302
|
+
}
|
|
303
|
+
|
|
266
304
|
optional string product_id = 1;
|
|
267
305
|
optional string variant_id = 2;
|
|
306
|
+
optional uint32 quantity = 3;
|
|
307
|
+
optional Session session = 4;
|
|
308
|
+
optional Localization localization = 5; // for taxing, currency, etc.?
|
|
268
309
|
}
|
|
269
310
|
|
|
270
311
|
message IndividualProductVariantListRequest {
|
|
@@ -341,7 +382,7 @@ message IndividualProductVariant {
|
|
|
341
382
|
optional bool active = 23;
|
|
342
383
|
optional google.protobuf.Timestamp valid_from = 24;
|
|
343
384
|
optional google.protobuf.Timestamp valid_to = 25;
|
|
344
|
-
repeated io.restorecommerce.attribute.Attribute
|
|
385
|
+
repeated io.restorecommerce.attribute.Attribute attributes = 26;
|
|
345
386
|
optional Package package = 27; // size for shipping
|
|
346
387
|
}
|
|
347
388
|
|
|
@@ -351,7 +392,8 @@ message IndividualProductVariantResponse {
|
|
|
351
392
|
}
|
|
352
393
|
|
|
353
394
|
message IndividualProductVariantListResponse {
|
|
354
|
-
repeated
|
|
395
|
+
repeated IndividualProductVariantResponse items = 1;
|
|
355
396
|
optional uint32 total_count = 2;
|
|
356
397
|
optional io.restorecommerce.status.OperationStatus operation_status = 3;
|
|
398
|
+
optional Session session = 4;
|
|
357
399
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@restorecommerce/protos",
|
|
3
|
-
"version": "6.11.
|
|
3
|
+
"version": "6.11.2",
|
|
4
4
|
"description": "Protobuf descriptors for Restorecommerce services",
|
|
5
5
|
"author": "n-fuse GmbH",
|
|
6
6
|
"repository": {
|
|
@@ -15,5 +15,5 @@
|
|
|
15
15
|
"protobufs"
|
|
16
16
|
],
|
|
17
17
|
"scripts": {},
|
|
18
|
-
"gitHead": "
|
|
18
|
+
"gitHead": "7e6127b5e0c68b998bfa54364d23fa6461bf1b76"
|
|
19
19
|
}
|