idosell 0.3.20 → 0.4.3
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/README.md +1 -1
- package/changelog.md +6 -0
- package/dist/app.d.ts +5 -5
- package/dist/gateways.d.ts +330 -329
- package/dist/index.js +3 -3
- package/dist/methods/getEntries.js +1 -0
- package/dist/methods/putProductsAttachments.js +1 -0
- package/dist/reqparams.d.ts +3870 -0
- package/dist/responses.d.ts +993 -51
- package/package.json +3 -2
- package/tests/getEntries.test.js +2 -7
- package/tests/getOrdersAuctionDetails.test.js +1 -1
- package/tests/postOrdersDocumentsCreate.test.js +2 -2
- package/tests/putProductsAttachments.test.js +2 -2
package/dist/gateways.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { PagableGateway, AppendableGateway, Gateway, DateLike, JSObject } from "./app.d.ts"
|
|
2
|
-
import type { GetClientsResponse, SearchClientsCrmResponse, GetClientsDeliveryAddressResponse, SearchClientsGiftcardsResponse, SearchClientsNewsletterEmailResponse, SearchClientsNewsletterSmsResponse, GetClientsPayerAddressResponse, GetConfigVariablesResponse, GetCouriersAssignedToShippingProfilesResponse, GetCouriersPickupPointsResponse, GetMenuResponse, GetOrdersAnalyticsResponse, GetOrdersAuctionDetailsResponse, GetOrdersDocumentsResponse, SearchOrdersOpinionsResponse, SearchOrdersResponse, GetOrdersPackagesResponse, GetOrdersProfitabilityResponse, GetPackagesLabelsResponse, SearchPackagesResponse, GetProductsSKUbyBarcodeResponse, GetProductsAuctionsResponse, GetProductsBrandsResponse, GetProductsCategoriesResponse,
|
|
2
|
+
import type { GetClientsResponse, PostClientsResponse, SearchClientsCrmResponse, GetClientsDeliveryAddressResponse, PutClientsDeliveryAddressResponse, SearchClientsGiftcardsResponse, SearchClientsNewsletterEmailResponse, SearchClientsNewsletterSmsResponse, GetClientsPayerAddressResponse, GetConfigVariablesResponse, GetCouriersAssignedToShippingProfilesResponse, GetCouriersPickupPointsResponse, PostCouriersPickupPointsResponse, PutCouriersPickupPointsResponse, GetCpaResponse, GetEntriesResponse, GetEntriesPagesToDisplayResponse, GetMenuResponse, PostMenuResponse, PutMenuResponse, GetOrdersAnalyticsResponse, GetOrdersAuctionDetailsResponse, PostOrdersDocumentsCreateResponse, GetOrdersDocumentsResponse, GetOrdersHistoryResponse, SearchOrdersOpinionsResponse, SearchOrdersResponse, PostOrdersResponse, PutOrdersResponse, GetOrdersPackagesResponse, GetOrdersProfitabilityResponse, GetOrdersStatusesResponse, GetPackagesLabelsResponse, PostPackagesLabelsResponse, SearchPackagesResponse, GetPaymentsResponse, PostPaymentsResponse, PostPaymentsRepaymentResponse, GetProductsSKUbyBarcodeResponse, PutProductsAttachmentsResponse, GetProductsAuctionsResponse, GetProductsBrandsResponse, GetProductsCategoriesResponse, PutProductsCategoriesResponse, SearchProductsCategoriesIdosellResponse, GetProductsCodeExistenceResponse, SearchProductsDeliveryTimeResponse, GetProductsDescriptionsResponse, GetProductsIdBySizecodeResponse, GetProductsOmnibusPricesResponse, GetProductsOpinionsResponse, SearchProductsParametersResponse, SearchProductsResponse, PostProductsResponse, PutProductsResponse, GetProductsReservationsResponse, GetProductsSeriesResponse, GetProductsSizesResponse, GetProductsStocksResponse, GetProductsStrikethroughPricesResponse, GetResponsibilityEntitiesResponse, PostResponsibilityEntitiesResponse, GetReturnsResponse, PostReturnsResponse, PutReturnsResponse, GetRmaResponse, PutRmaResponse, GetShopsCurrenciesResponse, GetShopsLanguagesResponse, GetSizechartsResponse, GetSizesResponse, GetSnippetsCampaignResponse, GetSnippetsCookiesResponse, GetSnippetsResponse, GetSystemConfigResponse, GetSystemCurrenciesResponse, GetSystemProcessesAutomationResponse, GetSystemShopsDataResponse, GetSystemUnitsResponse, GetSystemUsersResponse, GetVouchersTypesResponse, GetVouchersResponse, GetWarrantiesResponse, GetWmsLocationsResponse, GetWmsStocksdocumentsDocumentsResponse, PostWmsStocksdocumentsDocumentsResponse, GetWmsStocksdocumentsProductsResponse, PostWmsStocksdocumentsProductsResponse, PutWmsStocksdocumentsProductsResponse, GetWmsSuppliersResponse } from "./responses.d.ts"
|
|
3
|
+
import type * as RequestParams from "./reqparams.d.ts";
|
|
3
4
|
import * as ENUMS from "./enums";
|
|
4
5
|
|
|
5
6
|
export interface GetClientsBalanceRequest extends PagableGateway<GetClientsBalanceRequest> {
|
|
@@ -27,7 +28,7 @@ export interface PostClientsBalanceRequest extends Gateway {
|
|
|
27
28
|
/** Operation: - add, - remove. */
|
|
28
29
|
operation: (value: string) => this;
|
|
29
30
|
/** Value to add or remove from balance. */
|
|
30
|
-
balance: (value:
|
|
31
|
+
balance: (value: number) => this;
|
|
31
32
|
/** Currency of operation. */
|
|
32
33
|
currency: (value: string) => this;
|
|
33
34
|
/** Note. */
|
|
@@ -40,7 +41,7 @@ export interface PostClientsBalanceRequest extends Gateway {
|
|
|
40
41
|
remove: (balance: number, currency: string) => this;
|
|
41
42
|
}
|
|
42
43
|
|
|
43
|
-
export interface GetClientsRequest extends PagableGateway<GetClientsRequest,GetClientsResponse> {
|
|
44
|
+
export interface GetClientsRequest extends PagableGateway<GetClientsRequest, GetClientsResponse> {
|
|
44
45
|
/** Customer numbers. */
|
|
45
46
|
clientsIds: (value: number|string|number[]|string[]) => this;
|
|
46
47
|
/** External system codes list */
|
|
@@ -71,9 +72,9 @@ export interface GetClientsRequest extends PagableGateway<GetClientsRequest,GetC
|
|
|
71
72
|
lastModified: (dateFrom: DateLike, dateTo: DateLike) => this;
|
|
72
73
|
}
|
|
73
74
|
|
|
74
|
-
export interface PostClientsRequest extends AppendableGateway<PostClientsRequest> {
|
|
75
|
+
export interface PostClientsRequest extends AppendableGateway<PostClientsRequest, PostClientsResponse, RequestParams.PostClientsParams> {
|
|
75
76
|
/** Customer data. */
|
|
76
|
-
clients: (value:
|
|
77
|
+
clients: (value: RequestParams.PostClientsParams["clients"]) => this;
|
|
77
78
|
/** Customer's login. */
|
|
78
79
|
login: (login: string) => this
|
|
79
80
|
/** External system code. */
|
|
@@ -131,9 +132,9 @@ export interface PostClientsRequest extends AppendableGateway<PostClientsRequest
|
|
|
131
132
|
/** Field used for identifying request-response pairs for the endpoint. */
|
|
132
133
|
request_reference: (request_reference: string) => this
|
|
133
134
|
/** List of shops where a customer agreed or didn't agree to receive email newsletter. */
|
|
134
|
-
newsletter_email_approvals: (newsletter_email_approvals:
|
|
135
|
+
newsletter_email_approvals: (newsletter_email_approvals: RequestParams.PostClientsParams["clients"][number]["newsletter_email_approvals"]) => this
|
|
135
136
|
/** List of shops where a customer agreed or didn't agree to receive sms newsletter. */
|
|
136
|
-
newsletter_sms_approvals: (newsletter_sms_approvals:
|
|
137
|
+
newsletter_sms_approvals: (newsletter_sms_approvals: RequestParams.PostClientsParams["clients"][number]["newsletter_sms_approvals"]) => this
|
|
137
138
|
/** Block assigning of discount groups automatically based on order history */
|
|
138
139
|
block_group_auto_assignment: (block_group_auto_assignment: boolean) => this
|
|
139
140
|
}
|
|
@@ -213,7 +214,7 @@ export interface PutClientsRequest extends AppendableGateway<PutClientsRequest>
|
|
|
213
214
|
clientNote: (clientNote: string) => this
|
|
214
215
|
}
|
|
215
216
|
|
|
216
|
-
export interface SearchClientsCrmRequest extends PagableGateway<SearchClientsCrmRequest,SearchClientsCrmResponse> {
|
|
217
|
+
export interface SearchClientsCrmRequest extends PagableGateway<SearchClientsCrmRequest, SearchClientsCrmResponse, RequestParams.SearchClientsCrmParams> {
|
|
217
218
|
/** Customer's login. */
|
|
218
219
|
clientLogin: (value: string) => this;
|
|
219
220
|
/** Determines, whether client is a wholesaler. */
|
|
@@ -227,21 +228,21 @@ export interface SearchClientsCrmRequest extends PagableGateway<SearchClientsCrm
|
|
|
227
228
|
/** Customer group number */
|
|
228
229
|
clientDiscountGroupNumber: (value: number|string) => this;
|
|
229
230
|
/** Date range of customer registrations */
|
|
230
|
-
clientRegistrationDate: (value:
|
|
231
|
+
clientRegistrationDate: (value: RequestParams.SearchClientsCrmParams["clientRegistrationDate"]) => this;
|
|
231
232
|
/** Date of last customer login (YYYY-MM-DD) */
|
|
232
|
-
clientLastLoginDate: (value:
|
|
233
|
+
clientLastLoginDate: (value: RequestParams.SearchClientsCrmParams["clientLastLoginDate"]) => this;
|
|
233
234
|
/** Customer type, possible values: - person - if client sex is not determined, - person_male - when client is a male, - person_female - when a customer is a woman, - firm - when client is company. */
|
|
234
235
|
clientType: (value: 'person'|'person_male'|'person_female'|'firm') => this;
|
|
235
236
|
/** Information about the loyalty program possible values: - yes_voucher - when customers are in a loyalty program and have only used vouchers, - yes_voucher_cash - when customers are in a loyalty program and have only used vouchers or cash deposits, - yes_clients, - yes_orders - when customers are in the loyalty program and have made at least one order, - no - when customers are in the loyalty program, - banned - when customers are blocked. */
|
|
236
|
-
clientAffiliateProgram: (value:
|
|
237
|
+
clientAffiliateProgram: (value: RequestParams.SearchClientsCrmParams["clientAffiliateProgram"]) => this;
|
|
237
238
|
/** Permission to E-mail Newsletter. */
|
|
238
239
|
newsletterEmailApproval: (value: string) => this;
|
|
239
240
|
/** Permission to SMS Newsletter. */
|
|
240
241
|
newsletterSmsApproval: (value: string) => this;
|
|
241
242
|
/** Shops */
|
|
242
|
-
searchByShops: (value:
|
|
243
|
+
searchByShops: (value: RequestParams.SearchClientsCrmParams["searchByShops"]) => this;
|
|
243
244
|
/** Loyalty cards: */
|
|
244
|
-
clientLoyaltyCard: (value:
|
|
245
|
+
clientLoyaltyCard: (value: RequestParams.SearchClientsCrmParams["clientLoyaltyCard"]) => this;
|
|
245
246
|
/** External system code. */
|
|
246
247
|
clientCodeExternal: (value: string) => this;
|
|
247
248
|
/** External system codes list. */
|
|
@@ -257,13 +258,13 @@ export interface SearchClientsCrmRequest extends PagableGateway<SearchClientsCrm
|
|
|
257
258
|
/** E-mail address. */
|
|
258
259
|
clientEmail: (value: string) => this;
|
|
259
260
|
/** List of shops where a customer agreed or didn't agree to receive email newsletter. */
|
|
260
|
-
newsletterEmailApprovalsData: (value:
|
|
261
|
+
newsletterEmailApprovalsData: (value: RequestParams.SearchClientsCrmParams["newsletterEmailApprovalsData"]) => this;
|
|
261
262
|
/** List of shops where a customer agreed or didn't agree to receive sms newsletter. */
|
|
262
|
-
newsletterSmsApprovalsData: (value:
|
|
263
|
+
newsletterSmsApprovalsData: (value: RequestParams.SearchClientsCrmParams["newsletterSmsApprovalsData"]) => this;
|
|
263
264
|
/** Customer loyalty card number, omitted when has_loyalty_card = no. */
|
|
264
265
|
clientLoyaltyCardNumber: (value: string) => this;
|
|
265
266
|
/** Orders. */
|
|
266
|
-
orders: (value:
|
|
267
|
+
orders: (value: RequestParams.SearchClientsCrmParams["orders"]) => this;
|
|
267
268
|
/** Elements to be returned by the endpoint. By default all elements are returned */
|
|
268
269
|
returnElements: (value: string|string[]) => this;
|
|
269
270
|
/** Page with results number. Numeration starts from 0 */
|
|
@@ -271,7 +272,7 @@ export interface SearchClientsCrmRequest extends PagableGateway<SearchClientsCrm
|
|
|
271
272
|
/** Number of results on page. Value from 1 to 100 */
|
|
272
273
|
resultsLimit: (value: number|string) => this;
|
|
273
274
|
/** Determines, if data - that will be returned - will be exactly as entered values, or values should be fragment of customer data. */
|
|
274
|
-
settingsExactSearch: (value:
|
|
275
|
+
settingsExactSearch: (value: boolean) => this;
|
|
275
276
|
/** Define range of dates */
|
|
276
277
|
registered: (dateFrom: DateLike, dateTo: DateLike) => this;
|
|
277
278
|
/** Define range of dates */
|
|
@@ -333,9 +334,9 @@ export interface PostClientsDeliveryAddressRequest extends AppendableGateway<Pos
|
|
|
333
334
|
clientDeliveryAddressCountry: (clientDeliveryAddressCountry: string) => this
|
|
334
335
|
}
|
|
335
336
|
|
|
336
|
-
export interface PutClientsDeliveryAddressRequest extends AppendableGateway<PutClientsDeliveryAddressRequest> {
|
|
337
|
+
export interface PutClientsDeliveryAddressRequest extends AppendableGateway<PutClientsDeliveryAddressRequest, PutClientsDeliveryAddressResponse, RequestParams.PutClientsDeliveryAddressParams> {
|
|
337
338
|
/** Customer data. */
|
|
338
|
-
clients: (value:
|
|
339
|
+
clients: (value: RequestParams.PutClientsDeliveryAddressParams["clients"]) => this;
|
|
339
340
|
/** Customer's login. */
|
|
340
341
|
clientLogin: (clientLogin: string) => this
|
|
341
342
|
/** External system code. */
|
|
@@ -444,11 +445,11 @@ export interface PutClientsGiftcardsRequest extends AppendableGateway<PutClients
|
|
|
444
445
|
set: (amount: number, currency: string) => this;
|
|
445
446
|
}
|
|
446
447
|
|
|
447
|
-
export interface SearchClientsGiftcardsRequest extends Gateway<SearchClientsGiftcardsResponse> {
|
|
448
|
+
export interface SearchClientsGiftcardsRequest extends Gateway<SearchClientsGiftcardsResponse, RequestParams.SearchClientsGiftcardsParams> {
|
|
448
449
|
/** List of gift cards */
|
|
449
|
-
giftCards: (value:
|
|
450
|
+
giftCards: (value: RequestParams.SearchClientsGiftcardsParams["giftCards"]) => this;
|
|
450
451
|
/** element is an element array of type searchGiftCards */
|
|
451
|
-
searchGiftCards: (value:
|
|
452
|
+
searchGiftCards: (value: RequestParams.SearchClientsGiftcardsParams["searchGiftCards"]) => this;
|
|
452
453
|
/** Define giftCards values by passing them as an array */
|
|
453
454
|
ids: (values: number|string|number[]|string[]) => this;
|
|
454
455
|
/** Define giftCards values by passing them as an array */
|
|
@@ -504,11 +505,11 @@ export interface PutClientsMembershipCardsRequest extends AppendableGateway<PutC
|
|
|
504
505
|
errors: (errors: JSObject) => this
|
|
505
506
|
}
|
|
506
507
|
|
|
507
|
-
export interface SearchClientsNewsletterEmailRequest extends PagableGateway<SearchClientsNewsletterEmailRequest,SearchClientsNewsletterEmailResponse> {
|
|
508
|
-
shops: (value:
|
|
508
|
+
export interface SearchClientsNewsletterEmailRequest extends PagableGateway<SearchClientsNewsletterEmailRequest, SearchClientsNewsletterEmailResponse, RequestParams.SearchClientsNewsletterEmailParams> {
|
|
509
|
+
shops: (value: RequestParams.SearchClientsNewsletterEmailParams["shops"]) => this;
|
|
509
510
|
/** Customer language ID. */
|
|
510
511
|
language: (value: string) => this;
|
|
511
|
-
date: (value:
|
|
512
|
+
date: (value: RequestParams.SearchClientsNewsletterEmailParams["date"]) => this;
|
|
512
513
|
/** Elements to be returned by the endpoint. By default all elements are returned */
|
|
513
514
|
return_elements: (value: string|string[]) => this;
|
|
514
515
|
/** Results page number. Numbering begins at 0. Default value: 0. */
|
|
@@ -519,11 +520,11 @@ export interface SearchClientsNewsletterEmailRequest extends PagableGateway<Sear
|
|
|
519
520
|
dates: (dateFrom: DateLike, dateTo: DateLike) => this;
|
|
520
521
|
}
|
|
521
522
|
|
|
522
|
-
export interface SearchClientsNewsletterSmsRequest extends PagableGateway<SearchClientsNewsletterSmsRequest,SearchClientsNewsletterSmsResponse> {
|
|
523
|
-
shops: (value:
|
|
523
|
+
export interface SearchClientsNewsletterSmsRequest extends PagableGateway<SearchClientsNewsletterSmsRequest, SearchClientsNewsletterSmsResponse, RequestParams.SearchClientsNewsletterSmsParams> {
|
|
524
|
+
shops: (value: RequestParams.SearchClientsNewsletterSmsParams["shops"]) => this;
|
|
524
525
|
/** Customer language ID. */
|
|
525
526
|
language: (value: string) => this;
|
|
526
|
-
date: (value:
|
|
527
|
+
date: (value: RequestParams.SearchClientsNewsletterSmsParams["date"]) => this;
|
|
527
528
|
/** Elements to be returned by the endpoint. By default all elements are returned */
|
|
528
529
|
return_elements: (value: string|string[]) => this;
|
|
529
530
|
/** Results page number. Numbering begins at 0. Default value: 0. */
|
|
@@ -542,7 +543,7 @@ export interface DeleteClientsPayerAddressRequest extends AppendableGateway<Dele
|
|
|
542
543
|
payerAddressId: (payerAddressId: number|string) => this
|
|
543
544
|
}
|
|
544
545
|
|
|
545
|
-
export interface GetClientsPayerAddressRequest extends PagableGateway<GetClientsPayerAddressRequest,GetClientsPayerAddressResponse> {
|
|
546
|
+
export interface GetClientsPayerAddressRequest extends PagableGateway<GetClientsPayerAddressRequest, GetClientsPayerAddressResponse> {
|
|
546
547
|
/** Unique client's number. */
|
|
547
548
|
clientId: (value: string) => this;
|
|
548
549
|
/** Page with results number. Numeration starts from 0 */
|
|
@@ -756,7 +757,7 @@ export interface PostClientsProfitPointsRequest extends Gateway {
|
|
|
756
757
|
/** Operation: - add, - remove. */
|
|
757
758
|
operation: (value: string) => this;
|
|
758
759
|
/** Amount of points to add or subtract. */
|
|
759
|
-
score: (value:
|
|
760
|
+
score: (value: number) => this;
|
|
760
761
|
note: (value: string) => this;
|
|
761
762
|
/** Prepayment ID. */
|
|
762
763
|
order_number: (value: number|string) => this;
|
|
@@ -814,7 +815,7 @@ export interface PutClientsTagsRequest extends AppendableGateway<PutClientsTagsR
|
|
|
814
815
|
tagValue: (tagValue: number|string) => this
|
|
815
816
|
}
|
|
816
817
|
|
|
817
|
-
export interface GetConfigVariablesRequest extends PagableGateway<GetConfigVariablesRequest,GetConfigVariablesResponse> {
|
|
818
|
+
export interface GetConfigVariablesRequest extends PagableGateway<GetConfigVariablesRequest, GetConfigVariablesResponse> {
|
|
818
819
|
/** Which component is affected by the configuration. */
|
|
819
820
|
type: (value: 'snippets_campaign') => this;
|
|
820
821
|
/** List of item identifiers for given configuration type. Eg. snippet campaign identifiers. */
|
|
@@ -869,7 +870,7 @@ export interface DeleteCouriersPickupPointsRequest extends AppendableGateway<Del
|
|
|
869
870
|
courierId: (courierId: number|string) => this
|
|
870
871
|
}
|
|
871
872
|
|
|
872
|
-
export interface GetCouriersPickupPointsRequest extends PagableGateway<GetCouriersPickupPointsRequest,GetCouriersPickupPointsResponse> {
|
|
873
|
+
export interface GetCouriersPickupPointsRequest extends PagableGateway<GetCouriersPickupPointsRequest, GetCouriersPickupPointsResponse> {
|
|
873
874
|
/** Courier ID. */
|
|
874
875
|
courierId: (value: number|string) => this;
|
|
875
876
|
/** Collection point ID. */
|
|
@@ -882,28 +883,28 @@ export interface GetCouriersPickupPointsRequest extends PagableGateway<GetCourie
|
|
|
882
883
|
resultsLimit: (value: number|string) => this;
|
|
883
884
|
}
|
|
884
885
|
|
|
885
|
-
export interface PostCouriersPickupPointsRequest extends AppendableGateway<PostCouriersPickupPointsRequest> {
|
|
886
|
-
pickupPoints: (value:
|
|
886
|
+
export interface PostCouriersPickupPointsRequest extends AppendableGateway<PostCouriersPickupPointsRequest, PostCouriersPickupPointsResponse, RequestParams.PostCouriersPickupPointsParams> {
|
|
887
|
+
pickupPoints: (value: RequestParams.PostCouriersPickupPointsParams["pickupPoints"]) => this;
|
|
887
888
|
/** external system code. */
|
|
888
889
|
pickupPointExternalId: (pickupPointExternalId: string) => this
|
|
889
890
|
/** Courier ID. */
|
|
890
891
|
courierId: (courierId: number|string) => this
|
|
891
892
|
/** collection point details. */
|
|
892
|
-
descriptions: (descriptions:
|
|
893
|
+
descriptions: (descriptions: RequestParams.PostCouriersPickupPointsParams["pickupPoints"][number]["descriptions"]) => this
|
|
893
894
|
/** Accepted payment types. */
|
|
894
895
|
paymentForms: (paymentForms: string|string[]) => this
|
|
895
896
|
/** Collection point activity. Available values: available, outOfService . */
|
|
896
897
|
serviceStatus: (serviceStatus: 'out_of_service'|'available') => this
|
|
897
898
|
/** Pickup point address. */
|
|
898
|
-
address: (address:
|
|
899
|
+
address: (address: RequestParams.PostCouriersPickupPointsParams["pickupPoints"][number]["address"]) => this
|
|
899
900
|
/** Geographic coordinates. */
|
|
900
|
-
coordinates: (coordinates:
|
|
901
|
+
coordinates: (coordinates: RequestParams.PostCouriersPickupPointsParams["pickupPoints"][number]["coordinates"]) => this
|
|
901
902
|
/** Personal collection point work hours. */
|
|
902
|
-
operatingDays: (operatingDays:
|
|
903
|
+
operatingDays: (operatingDays: RequestParams.PostCouriersPickupPointsParams["pickupPoints"][number]["operatingDays"]) => this
|
|
903
904
|
}
|
|
904
905
|
|
|
905
|
-
export interface PutCouriersPickupPointsRequest extends AppendableGateway<PutCouriersPickupPointsRequest> {
|
|
906
|
-
pickupPoints: (value:
|
|
906
|
+
export interface PutCouriersPickupPointsRequest extends AppendableGateway<PutCouriersPickupPointsRequest, PutCouriersPickupPointsResponse, RequestParams.PutCouriersPickupPointsParams> {
|
|
907
|
+
pickupPoints: (value: RequestParams.PutCouriersPickupPointsParams["pickupPoints"]) => this;
|
|
907
908
|
/** Collection point ID. */
|
|
908
909
|
pickupPointId: (pickupPointId: string) => this
|
|
909
910
|
/** external system code. */
|
|
@@ -911,17 +912,17 @@ export interface PutCouriersPickupPointsRequest extends AppendableGateway<PutCou
|
|
|
911
912
|
/** Courier ID. */
|
|
912
913
|
courierId: (courierId: number|string) => this
|
|
913
914
|
/** collection point details. */
|
|
914
|
-
descriptions: (descriptions:
|
|
915
|
+
descriptions: (descriptions: RequestParams.PutCouriersPickupPointsParams["pickupPoints"][number]["descriptions"]) => this
|
|
915
916
|
/** Accepted payment types. */
|
|
916
917
|
paymentForms: (paymentForms: string|string[]) => this
|
|
917
918
|
/** Collection point activity. Available values: available, outOfService . */
|
|
918
919
|
serviceStatus: (serviceStatus: 'out_of_service'|'available') => this
|
|
919
920
|
/** Pickup point address. */
|
|
920
|
-
address: (address:
|
|
921
|
+
address: (address: RequestParams.PutCouriersPickupPointsParams["pickupPoints"][number]["address"]) => this
|
|
921
922
|
/** Geographic coordinates. */
|
|
922
|
-
coordinates: (coordinates:
|
|
923
|
+
coordinates: (coordinates: RequestParams.PutCouriersPickupPointsParams["pickupPoints"][number]["coordinates"]) => this
|
|
923
924
|
/** Personal collection point work hours. */
|
|
924
|
-
operatingDays: (operatingDays:
|
|
925
|
+
operatingDays: (operatingDays: RequestParams.PutCouriersPickupPointsParams["pickupPoints"][number]["operatingDays"]) => this
|
|
925
926
|
}
|
|
926
927
|
|
|
927
928
|
export interface GetCpaCampaignRequest extends PagableGateway<GetCpaCampaignRequest> {
|
|
@@ -968,7 +969,7 @@ export interface DeleteCpaCampaignRequest extends Gateway {
|
|
|
968
969
|
id: (value: number|string|number[]|string[]) => this;
|
|
969
970
|
}
|
|
970
971
|
|
|
971
|
-
export interface GetCpaRequest extends PagableGateway<GetCpaRequest> {
|
|
972
|
+
export interface GetCpaRequest extends PagableGateway<GetCpaRequest, GetCpaResponse> {
|
|
972
973
|
/** List of campaign identifiers */
|
|
973
974
|
campaign: (value: number|string|number[]|string[]) => this;
|
|
974
975
|
/** List of identifiers */
|
|
@@ -1161,7 +1162,7 @@ export interface DeleteEntriesRequest extends Gateway {
|
|
|
1161
1162
|
entryId: (value: number|string) => this;
|
|
1162
1163
|
}
|
|
1163
1164
|
|
|
1164
|
-
export interface GetEntriesRequest extends Gateway {
|
|
1165
|
+
export interface GetEntriesRequest extends Gateway<GetEntriesResponse> {
|
|
1165
1166
|
/** Entry ID */
|
|
1166
1167
|
entryId: (value: number|string) => this;
|
|
1167
1168
|
/** Language ID */
|
|
@@ -1230,7 +1231,7 @@ export interface PutEntriesRequest extends Gateway {
|
|
|
1230
1231
|
link: (value: string) => this;
|
|
1231
1232
|
}
|
|
1232
1233
|
|
|
1233
|
-
export interface GetEntriesPagesToDisplayRequest extends Gateway {
|
|
1234
|
+
export interface GetEntriesPagesToDisplayRequest extends Gateway<GetEntriesPagesToDisplayResponse> {
|
|
1234
1235
|
/** Language ID */
|
|
1235
1236
|
langId: (value: string) => this;
|
|
1236
1237
|
}
|
|
@@ -1305,10 +1306,10 @@ export interface GetMenuRequest extends Gateway<GetMenuResponse> {
|
|
|
1305
1306
|
textid_separator: (value: string) => this;
|
|
1306
1307
|
}
|
|
1307
1308
|
|
|
1308
|
-
export interface PostMenuRequest extends AppendableGateway<PostMenuRequest> {
|
|
1309
|
-
menu_list: (value:
|
|
1309
|
+
export interface PostMenuRequest extends AppendableGateway<PostMenuRequest, PostMenuResponse, RequestParams.PostMenuParams> {
|
|
1310
|
+
menu_list: (value: RequestParams.PostMenuParams["menu_list"]) => this;
|
|
1310
1311
|
/** Settings */
|
|
1311
|
-
settings: (value:
|
|
1312
|
+
settings: (value: RequestParams.PostMenuParams["settings"]) => this;
|
|
1312
1313
|
/** Shop Id. */
|
|
1313
1314
|
shop_id: (shop_id: number|string) => this
|
|
1314
1315
|
/** Menu ID. */
|
|
@@ -1318,13 +1319,13 @@ export interface PostMenuRequest extends AppendableGateway<PostMenuRequest> {
|
|
|
1318
1319
|
/** Menu element text identifier. Example: "item1\item2". */
|
|
1319
1320
|
parent_textid: (parent_textid: string) => this
|
|
1320
1321
|
/** */
|
|
1321
|
-
lang_data: (lang_data:
|
|
1322
|
+
lang_data: (lang_data: RequestParams.PostMenuParams["menu_list"][number]["lang_data"]) => this
|
|
1322
1323
|
}
|
|
1323
1324
|
|
|
1324
|
-
export interface PutMenuRequest extends AppendableGateway<PutMenuRequest> {
|
|
1325
|
-
menu_list: (value:
|
|
1325
|
+
export interface PutMenuRequest extends AppendableGateway<PutMenuRequest, PutMenuResponse, RequestParams.PutMenuParams> {
|
|
1326
|
+
menu_list: (value: RequestParams.PutMenuParams["menu_list"]) => this;
|
|
1326
1327
|
/** Settings. */
|
|
1327
|
-
settings: (value:
|
|
1328
|
+
settings: (value: RequestParams.PutMenuParams["settings"]) => this;
|
|
1328
1329
|
/** Shop Id. */
|
|
1329
1330
|
shop_id: (shop_id: number|string) => this
|
|
1330
1331
|
/** Menu ID. */
|
|
@@ -1334,7 +1335,7 @@ export interface PutMenuRequest extends AppendableGateway<PutMenuRequest> {
|
|
|
1334
1335
|
/** Menu element text identifier. Example: "item1\item2\item3". */
|
|
1335
1336
|
item_textid: (item_textid: string) => this
|
|
1336
1337
|
/** */
|
|
1337
|
-
lang_data: (lang_data:
|
|
1338
|
+
lang_data: (lang_data: RequestParams.PutMenuParams["menu_list"][number]["lang_data"]) => this
|
|
1338
1339
|
}
|
|
1339
1340
|
|
|
1340
1341
|
export interface PutMenuSortRequest extends AppendableGateway<PutMenuSortRequest> {
|
|
@@ -1400,16 +1401,16 @@ export interface PutOrdersDevideRequest extends AppendableGateway<PutOrdersDevid
|
|
|
1400
1401
|
/** Products list. */
|
|
1401
1402
|
products: (value: Array<JSObject>) => this;
|
|
1402
1403
|
/** Whether to split payments */
|
|
1403
|
-
splitPayments: (value:
|
|
1404
|
+
splitPayments: (value: boolean) => this;
|
|
1404
1405
|
/** Item in basket. */
|
|
1405
1406
|
basketPosition: (basketPosition: number|string) => this
|
|
1406
1407
|
/** Quantity */
|
|
1407
1408
|
quantity: (quantity: number) => this
|
|
1408
1409
|
}
|
|
1409
1410
|
|
|
1410
|
-
export interface PostOrdersDocumentsCreateRequest extends Gateway {
|
|
1411
|
+
export interface PostOrdersDocumentsCreateRequest extends Gateway<PostOrdersDocumentsCreateResponse, RequestParams.PostOrdersDocumentsCreateParams> {
|
|
1411
1412
|
orderSerialNumbers: (value: number|string|number[]|string[]) => this;
|
|
1412
|
-
actualize: (value:
|
|
1413
|
+
actualize: (value: boolean) => this;
|
|
1413
1414
|
/** Document type */
|
|
1414
1415
|
documentType: (value: 'vat_invoice'|'fiscal_invoice'|'corrective_vat_invoice'|'fiscal_receipt'|'sales_confirmation') => this;
|
|
1415
1416
|
/** Document issued date */
|
|
@@ -1497,7 +1498,7 @@ export interface GetOrdersExportdocumentsJPKRequest extends Gateway {
|
|
|
1497
1498
|
/** Stock ID */
|
|
1498
1499
|
stockId: (value: number|string|number[]|string[]) => this;
|
|
1499
1500
|
/** Forces the file to be generated by background tasks. The file will be generated later. Then, after it is generated, you will be able to download the given file using the returned ID. The file will be available 24h after the task is completed. */
|
|
1500
|
-
forceBackgroundGenerate: (value:
|
|
1501
|
+
forceBackgroundGenerate: (value: boolean) => this;
|
|
1501
1502
|
/** Define range of dates */
|
|
1502
1503
|
dates: (dateFrom: DateLike, dateTo: DateLike) => this;
|
|
1503
1504
|
}
|
|
@@ -1514,7 +1515,7 @@ export interface PutOrdersHandlerRequest extends Gateway {
|
|
|
1514
1515
|
orderOperatorLogin: (value: string) => this;
|
|
1515
1516
|
}
|
|
1516
1517
|
|
|
1517
|
-
export interface GetOrdersHistoryRequest extends Gateway {
|
|
1518
|
+
export interface GetOrdersHistoryRequest extends Gateway<GetOrdersHistoryResponse> {
|
|
1518
1519
|
/** Order serial number. */
|
|
1519
1520
|
orderSerialNumber: (value: number|string) => this;
|
|
1520
1521
|
}
|
|
@@ -1556,21 +1557,21 @@ export interface GetOrdersLabelsRequest extends Gateway {
|
|
|
1556
1557
|
orderSerialNumber: (value: number|string) => this;
|
|
1557
1558
|
}
|
|
1558
1559
|
|
|
1559
|
-
export interface SearchOrdersOpinionsRequest extends PagableGateway<SearchOrdersOpinionsRequest,SearchOrdersOpinionsResponse> {
|
|
1560
|
+
export interface SearchOrdersOpinionsRequest extends PagableGateway<SearchOrdersOpinionsRequest, SearchOrdersOpinionsResponse, RequestParams.SearchOrdersOpinionsParams> {
|
|
1560
1561
|
/** Review identification */
|
|
1561
|
-
opinion: (value:
|
|
1562
|
+
opinion: (value: RequestParams.SearchOrdersOpinionsParams["opinion"]) => this;
|
|
1562
1563
|
/** Orders. */
|
|
1563
|
-
orders: (value:
|
|
1564
|
+
orders: (value: RequestParams.SearchOrdersOpinionsParams["orders"]) => this;
|
|
1564
1565
|
/** Customer data. */
|
|
1565
|
-
clients: (value:
|
|
1566
|
+
clients: (value: RequestParams.SearchOrdersOpinionsParams["clients"]) => this;
|
|
1566
1567
|
/** Date range */
|
|
1567
|
-
dateRange: (value:
|
|
1568
|
+
dateRange: (value: RequestParams.SearchOrdersOpinionsParams["dateRange"]) => this;
|
|
1568
1569
|
/** Page with results number. Numeration starts from 0 */
|
|
1569
1570
|
resultsPage: (value: number|string) => this;
|
|
1570
1571
|
/** Number of results on page. Value from 1 to 100 */
|
|
1571
1572
|
resultsLimit: (value: number|string) => this;
|
|
1572
1573
|
/** Possibility of sorting returned list */
|
|
1573
|
-
ordersBy: (value:
|
|
1574
|
+
ordersBy: (value: RequestParams.SearchOrdersOpinionsParams["ordersBy"]) => this;
|
|
1574
1575
|
orderId: (value: string) => this;
|
|
1575
1576
|
orderSerialNumber: (value: string) => this;
|
|
1576
1577
|
clientId: (value: string) => this;
|
|
@@ -1596,9 +1597,9 @@ export interface GetOrdersRequest extends Gateway<SearchOrdersResponse> {
|
|
|
1596
1597
|
orderExternalId: (value: string) => this;
|
|
1597
1598
|
}
|
|
1598
1599
|
|
|
1599
|
-
export interface PostOrdersRequest extends AppendableGateway<PostOrdersRequest> {
|
|
1600
|
+
export interface PostOrdersRequest extends AppendableGateway<PostOrdersRequest, PostOrdersResponse, RequestParams.PostOrdersParams> {
|
|
1600
1601
|
/** Orders. */
|
|
1601
|
-
orders: (value:
|
|
1602
|
+
orders: (value: RequestParams.PostOrdersParams["orders"]) => this;
|
|
1602
1603
|
/** Order type. Allowed values. "retail" - retail order, "wholesale" - wholesale order (can be added only by customer with wholesale account registered). Default value:: "retail" */
|
|
1603
1604
|
orderType: (orderType: string) => this
|
|
1604
1605
|
/** Shop Id */
|
|
@@ -1612,7 +1613,7 @@ export interface PostOrdersRequest extends AppendableGateway<PostOrdersRequest>
|
|
|
1612
1613
|
/** Determines if customer unregistered. Allowed values. "y" - casual client, "n" - registered customer. Default value:: "y". If customer is unregistered, enter customer details in element: "clientWithoutAccountData". For client with account - existing login should be stored in: "clientLogin". */
|
|
1613
1614
|
clientWithoutAccount: (clientWithoutAccount: string) => this
|
|
1614
1615
|
/** Balance data for casual client. Object is necessary for casual clients (in case of client_once has y value). */
|
|
1615
|
-
clientWithoutAccountData: (clientWithoutAccountData:
|
|
1616
|
+
clientWithoutAccountData: (clientWithoutAccountData: RequestParams.PostOrdersParams["orders"][number]["clientWithoutAccountData"]) => this
|
|
1616
1617
|
/** Customer's login. */
|
|
1617
1618
|
clientLogin: (clientLogin: string) => this
|
|
1618
1619
|
/** Customer comments on order. */
|
|
@@ -1628,11 +1629,11 @@ export interface PostOrdersRequest extends AppendableGateway<PostOrdersRequest>
|
|
|
1628
1629
|
/** Delivery cost. */
|
|
1629
1630
|
deliveryCost: (deliveryCost: number) => this
|
|
1630
1631
|
/** Delivery address data. */
|
|
1631
|
-
clientDeliveryAddress: (clientDeliveryAddress:
|
|
1632
|
+
clientDeliveryAddress: (clientDeliveryAddress: RequestParams.PostOrdersParams["orders"][number]["clientDeliveryAddress"]) => this
|
|
1632
1633
|
/** Buyer's address data. */
|
|
1633
|
-
payerAddress: (payerAddress:
|
|
1634
|
+
payerAddress: (payerAddress: RequestParams.PostOrdersParams["orders"][number]["payerAddress"]) => this
|
|
1634
1635
|
/** Products list. */
|
|
1635
|
-
products: (products:
|
|
1636
|
+
products: (products: RequestParams.PostOrdersParams["orders"][number]["products"]) => this
|
|
1636
1637
|
/** Discount value. */
|
|
1637
1638
|
orderRebateValue: (orderRebateValue: number) => this
|
|
1638
1639
|
/** Order handler. */
|
|
@@ -1640,9 +1641,9 @@ export interface PostOrdersRequest extends AppendableGateway<PostOrdersRequest>
|
|
|
1640
1641
|
/** Omits collecting orders via IAI Bridge. */
|
|
1641
1642
|
ignoreBridge: (ignoreBridge: boolean) => this
|
|
1642
1643
|
/** Settings */
|
|
1643
|
-
settings: (settings:
|
|
1644
|
+
settings: (settings: RequestParams.PostOrdersParams["orders"][number]["settings"]) => this
|
|
1644
1645
|
/** Settlement by prices. "gross" - gross, "net" - net, "net_without_VAT" - net without VAT. */
|
|
1645
|
-
orderSettledAtPrice: (orderSettledAtPrice: 'gross'|'net'|'
|
|
1646
|
+
orderSettledAtPrice: (orderSettledAtPrice: 'gross'|'net'|'net_without_VAT') => this
|
|
1646
1647
|
/** Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no. */
|
|
1647
1648
|
clientRequestInvoice: (clientRequestInvoice: string) => this
|
|
1648
1649
|
/** Order settlement currency. */
|
|
@@ -1653,9 +1654,9 @@ export interface PostOrdersRequest extends AppendableGateway<PostOrdersRequest>
|
|
|
1653
1654
|
purchaseDate: (purchaseDate: string) => this
|
|
1654
1655
|
}
|
|
1655
1656
|
|
|
1656
|
-
export interface PutOrdersRequest extends AppendableGateway<PutOrdersRequest> {
|
|
1657
|
+
export interface PutOrdersRequest extends AppendableGateway<PutOrdersRequest, PutOrdersResponse, RequestParams.PutOrdersParams> {
|
|
1657
1658
|
/** Orders. */
|
|
1658
|
-
orders: (value:
|
|
1659
|
+
orders: (value: RequestParams.PutOrdersParams["orders"]) => this;
|
|
1659
1660
|
/** Order ID. */
|
|
1660
1661
|
orderId: (orderId: string) => this
|
|
1661
1662
|
/** Order serial number. */
|
|
@@ -1675,15 +1676,15 @@ export interface PutOrdersRequest extends AppendableGateway<PutOrdersRequest> {
|
|
|
1675
1676
|
/** Note to the order. */
|
|
1676
1677
|
orderNote: (orderNote: string) => this
|
|
1677
1678
|
/** Products list. */
|
|
1678
|
-
products: (products:
|
|
1679
|
+
products: (products: RequestParams.PutOrdersParams["orders"][number]["products"]) => this
|
|
1679
1680
|
/** Order payment method. Allowed values. "cash_on_delivery" - cash on delivery, "prepaid" - prepayment, "tradecredit" - Trade credit. */
|
|
1680
1681
|
orderPaymentType: (orderPaymentType: 'cash_on_delivery'|'prepaid'|'tradecredit') => this
|
|
1681
1682
|
/** Settlement by prices. "gross" - gross, "net" - net, "net_without_VAT" - net without VAT. */
|
|
1682
|
-
orderSettledAtPrice: (orderSettledAtPrice: 'gross'|'net'|'
|
|
1683
|
+
orderSettledAtPrice: (orderSettledAtPrice: 'gross'|'net'|'net_without_VAT') => this
|
|
1683
1684
|
/** Omits collecting orders via IAI Bridge. */
|
|
1684
1685
|
ignoreBridge: (ignoreBridge: boolean) => this
|
|
1685
1686
|
/** Settings */
|
|
1686
|
-
settings: (settings:
|
|
1687
|
+
settings: (settings: RequestParams.PutOrdersParams["orders"][number]["settings"]) => this
|
|
1687
1688
|
/** Consent to send data to cooperating services */
|
|
1688
1689
|
emailProcessingConsent: (emailProcessingConsent: 'yes'|'no'|'disabled') => this
|
|
1689
1690
|
/** Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no. */
|
|
@@ -1698,9 +1699,9 @@ export interface PutOrdersRequest extends AppendableGateway<PutOrdersRequest> {
|
|
|
1698
1699
|
estimatedDeliveryDate: (estimatedDeliveryDate: string) => this
|
|
1699
1700
|
}
|
|
1700
1701
|
|
|
1701
|
-
export interface SearchOrdersRequest extends PagableGateway<SearchOrdersRequest,SearchOrdersResponse> {
|
|
1702
|
+
export interface SearchOrdersRequest extends PagableGateway<SearchOrdersRequest, SearchOrdersResponse, RequestParams.SearchOrdersParams> {
|
|
1702
1703
|
/** Prepayment status. Status list: "unpaid" - not paid, "restored" - returned, "waiting" - not registered. */
|
|
1703
|
-
orderPrepaidStatus: (value:
|
|
1704
|
+
orderPrepaidStatus: (value: "unpaid" | "restored" | "waiting") => this;
|
|
1704
1705
|
/** Order status. Status list: "new" - not handled, "finished" - completed, "false" - false, "lost" - lost, "on_order" - in progress, "packed" - being picked, "ready" - ready, "canceled" - canceled by customer, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "suspended" - on hold, "joined" - merged, "finished_ext" - handled in FA application. */
|
|
1705
1706
|
ordersStatuses: (value: string|string[]) => this;
|
|
1706
1707
|
/** Order statusses ids. */
|
|
@@ -1721,13 +1722,13 @@ export interface SearchOrdersRequest extends PagableGateway<SearchOrdersRequest,
|
|
|
1721
1722
|
/** Order serial numbers. */
|
|
1722
1723
|
ordersSerialNumbers: (value: number|string|number[]|string[]) => this;
|
|
1723
1724
|
/** Customer data. */
|
|
1724
|
-
clients: (value:
|
|
1725
|
+
clients: (value: RequestParams.SearchOrdersParams["clients"]) => this;
|
|
1725
1726
|
/** Ranges of dates or serial numbers. */
|
|
1726
|
-
ordersRange: (value:
|
|
1727
|
+
ordersRange: (value: RequestParams.SearchOrdersParams["ordersRange"]) => this;
|
|
1727
1728
|
/** Order source data. */
|
|
1728
|
-
orderSource: (value:
|
|
1729
|
+
orderSource: (value: RequestParams.SearchOrdersParams["orderSource"]) => this;
|
|
1729
1730
|
/** Products list. */
|
|
1730
|
-
products: (value:
|
|
1731
|
+
products: (value: RequestParams.SearchOrdersParams["products"]) => this;
|
|
1731
1732
|
/** Page with results number. Numeration starts from 0 */
|
|
1732
1733
|
resultsPage: (value: number|string) => this;
|
|
1733
1734
|
/** Number of results on page. Value from 1 to 100 */
|
|
@@ -1735,11 +1736,11 @@ export interface SearchOrdersRequest extends PagableGateway<SearchOrdersRequest,
|
|
|
1735
1736
|
/** Customer asked for invoice. List of parameters: "y" - yes (paper invoicing ), "e" - yes (electronic invoicing ), "n" - no. */
|
|
1736
1737
|
clientRequestInvoice: (value: string) => this;
|
|
1737
1738
|
/** Information on consignments. */
|
|
1738
|
-
packages: (value:
|
|
1739
|
+
packages: (value: RequestParams.SearchOrdersParams["packages"]) => this;
|
|
1739
1740
|
/** Stock quantities data. */
|
|
1740
|
-
stocks: (value:
|
|
1741
|
+
stocks: (value: RequestParams.SearchOrdersParams["stocks"]) => this;
|
|
1741
1742
|
/** Used discount codes data. */
|
|
1742
|
-
campaign: (value:
|
|
1743
|
+
campaign: (value: RequestParams.SearchOrdersParams["campaign"]) => this;
|
|
1743
1744
|
/** Loyalty points. */
|
|
1744
1745
|
loyaltyPointsMode: (value: 'all'|'given'|'taken'|'given_or_taken'|'given_and_taken'|'not_given_nor_taken') => this;
|
|
1745
1746
|
/** Order handler. */
|
|
@@ -1747,13 +1748,13 @@ export interface SearchOrdersRequest extends PagableGateway<SearchOrdersRequest,
|
|
|
1747
1748
|
/** Order picker. */
|
|
1748
1749
|
orderPackingPersonLogin: (value: string) => this;
|
|
1749
1750
|
/** Possibility of sorting returned list */
|
|
1750
|
-
ordersBy: (value:
|
|
1751
|
+
ordersBy: (value: RequestParams.SearchOrdersParams["ordersBy"]) => this;
|
|
1751
1752
|
/** Method of searching orders by handler. */
|
|
1752
1753
|
searchingOperatorTypeMatch: (value: 'no_assignment'|'no_empty'|'empty') => this;
|
|
1753
1754
|
/** Orders with the exceeded date of shipment. */
|
|
1754
1755
|
ordersDelayed: (value: 'y'|'n') => this;
|
|
1755
1756
|
/** Combine the components of the set into one item */
|
|
1756
|
-
showBundles: (value:
|
|
1757
|
+
showBundles: (value: boolean) => this;
|
|
1757
1758
|
/** The order ID of the external service */
|
|
1758
1759
|
orderExternalId: (value: string) => this;
|
|
1759
1760
|
/** Order currency */
|
|
@@ -1798,7 +1799,7 @@ export interface GetOrdersPackagesRequest extends Gateway<GetOrdersPackagesRespo
|
|
|
1798
1799
|
/** RMA numbers. */
|
|
1799
1800
|
rmaNumbers: (value: number|string|number[]|string[]) => this;
|
|
1800
1801
|
/** Return parcel labels. */
|
|
1801
|
-
returnLabels: (value:
|
|
1802
|
+
returnLabels: (value: boolean) => this;
|
|
1802
1803
|
}
|
|
1803
1804
|
|
|
1804
1805
|
export interface PostOrdersPackagesRequest extends AppendableGateway<PostOrdersPackagesRequest> {
|
|
@@ -1836,7 +1837,7 @@ export interface GetOrdersPrinterDocumentsRequest extends Gateway {
|
|
|
1836
1837
|
objectNumber: (value: string) => this;
|
|
1837
1838
|
objectType: (value: string) => this;
|
|
1838
1839
|
printerAccessKey: (value: string) => this;
|
|
1839
|
-
skipNotGeneratedDocument: (value:
|
|
1840
|
+
skipNotGeneratedDocument: (value: boolean) => this;
|
|
1840
1841
|
}
|
|
1841
1842
|
|
|
1842
1843
|
export interface PutOrdersProductsSerialNumbersRequest extends AppendableGateway<PutOrdersProductsSerialNumbersRequest> {
|
|
@@ -1870,16 +1871,16 @@ export interface PutOrdersShippingCostsRequest extends Gateway {
|
|
|
1870
1871
|
/** Order serial number. */
|
|
1871
1872
|
orderSerialNumber: (value: number|string) => this;
|
|
1872
1873
|
/** Delivery cost. */
|
|
1873
|
-
deliveryCost: (value:
|
|
1874
|
+
deliveryCost: (value: number) => this;
|
|
1874
1875
|
/** Delivery VAT. */
|
|
1875
|
-
orderDeliveryVat: (value:
|
|
1876
|
+
orderDeliveryVat: (value: number) => this;
|
|
1876
1877
|
}
|
|
1877
1878
|
|
|
1878
|
-
export interface GetOrdersStatusesRequest extends Gateway {}
|
|
1879
|
+
export interface GetOrdersStatusesRequest extends Gateway<GetOrdersStatusesResponse> {}
|
|
1879
1880
|
|
|
1880
|
-
export interface SearchOrdersUnfinishedRequest extends PagableGateway<SearchOrdersUnfinishedRequest,SearchOrdersResponse> {
|
|
1881
|
+
export interface SearchOrdersUnfinishedRequest extends PagableGateway<SearchOrdersUnfinishedRequest, SearchOrdersResponse> {
|
|
1881
1882
|
/** Prepayment status. Status list: "unpaid" - not paid, "restored" - returned, "waiting" - not registered. */
|
|
1882
|
-
orderPrepaidStatus: (value:
|
|
1883
|
+
orderPrepaidStatus: (value: "unpaid" | "restored" | "waiting") => this;
|
|
1883
1884
|
/** Order status. Status list: "new" - not handled, "on_order" - in progress, "packed" - being picked, "packed_fulfillment" - being picked - fulfilment, "packed_ready" - packed, "ready" - ready, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "finished_ext" - handled in FA application. */
|
|
1884
1885
|
ordersStatuses: (value: string|string[]) => this;
|
|
1885
1886
|
/** Order statuses ids. */
|
|
@@ -1987,15 +1988,15 @@ export interface GetPackagesLabelsRequest extends Gateway<GetPackagesLabelsRespo
|
|
|
1987
1988
|
return: (returnId: number|string) => this;
|
|
1988
1989
|
}
|
|
1989
1990
|
|
|
1990
|
-
export interface PostPackagesLabelsRequest extends AppendableGateway<PostPackagesLabelsRequest> {
|
|
1991
|
+
export interface PostPackagesLabelsRequest extends AppendableGateway<PostPackagesLabelsRequest, PostPackagesLabelsResponse, RequestParams.PostPackagesLabelsParams> {
|
|
1991
1992
|
/** Id. */
|
|
1992
1993
|
eventId: (value: number|string) => this;
|
|
1993
1994
|
/** Type. */
|
|
1994
1995
|
eventType: (value: 'order'|'rma'|'return') => this;
|
|
1995
1996
|
/** Shipment configuration options available for a given courier */
|
|
1996
|
-
parcelParameters: (value:
|
|
1997
|
+
parcelParameters: (value: RequestParams.PostPackagesLabelsParams["parcelParameters"]) => this;
|
|
1997
1998
|
/** Shipment configuration options available for Inpost Smile courier */
|
|
1998
|
-
parcelParametersByPackages: (value:
|
|
1999
|
+
parcelParametersByPackages: (value: RequestParams.PostPackagesLabelsParams["parcelParametersByPackages"]) => this;
|
|
1999
2000
|
/** Package ID in system. */
|
|
2000
2001
|
packageId: (packageId: string) => this
|
|
2001
2002
|
}
|
|
@@ -2022,13 +2023,13 @@ export interface PutPackagesRequest extends AppendableGateway<PutPackagesRequest
|
|
|
2022
2023
|
packages: (packages: Array<JSObject>) => this
|
|
2023
2024
|
}
|
|
2024
2025
|
|
|
2025
|
-
export interface SearchPackagesRequest extends AppendableGateway<SearchPackagesRequest, SearchPackagesResponse> {
|
|
2026
|
+
export interface SearchPackagesRequest extends AppendableGateway<SearchPackagesRequest, SearchPackagesResponse, RequestParams.SearchPackagesParams> {
|
|
2026
2027
|
/** Consignments numbers. */
|
|
2027
2028
|
deliveryPackageNumbers: (value: string|string[]) => this;
|
|
2028
2029
|
/** Element, package is assigned to */
|
|
2029
|
-
events: (value:
|
|
2030
|
+
events: (value: RequestParams.SearchPackagesParams["events"]) => this;
|
|
2030
2031
|
/** Return parcel labels. */
|
|
2031
|
-
returnLabels: (value:
|
|
2032
|
+
returnLabels: (value: boolean) => this;
|
|
2032
2033
|
/** Type. */
|
|
2033
2034
|
eventType: (eventType: 'order'|'rma'|'return') => this
|
|
2034
2035
|
/** IDs. */
|
|
@@ -2053,7 +2054,7 @@ export interface PostPaymentsCashbackRequest extends Gateway {
|
|
|
2053
2054
|
/** Payment number - [order no.]-[payment no.], i.e. 1234-1. */
|
|
2054
2055
|
paymentNumber: (value: string) => this;
|
|
2055
2056
|
/** Refund value. */
|
|
2056
|
-
value: (value:
|
|
2057
|
+
value: (value: number) => this;
|
|
2057
2058
|
}
|
|
2058
2059
|
|
|
2059
2060
|
export interface PutPaymentsConfirmRequest extends Gateway {
|
|
@@ -2070,20 +2071,20 @@ export interface GetPaymentsFormsRequest extends Gateway {
|
|
|
2070
2071
|
activeOnly: (value: 'yes'|'no') => this;
|
|
2071
2072
|
}
|
|
2072
2073
|
|
|
2073
|
-
export interface GetPaymentsRequest extends Gateway {
|
|
2074
|
+
export interface GetPaymentsRequest extends Gateway<GetPaymentsResponse> {
|
|
2074
2075
|
/** Payment number consists of: source ID (order / return ID) and the payment ordinal number, e.g. 1234-1. */
|
|
2075
2076
|
paymentNumber: (value: string) => this;
|
|
2076
2077
|
/** Source type. */
|
|
2077
2078
|
sourceType: (value: 'order'|'return'|'rma') => this;
|
|
2078
2079
|
}
|
|
2079
2080
|
|
|
2080
|
-
export interface PostPaymentsRequest extends Gateway {
|
|
2081
|
+
export interface PostPaymentsRequest extends Gateway<PostPaymentsResponse, RequestParams.PostPaymentsParams> {
|
|
2081
2082
|
/** Source ID. */
|
|
2082
2083
|
sourceId: (value: number|string) => this;
|
|
2083
2084
|
/** Source type. */
|
|
2084
2085
|
sourceType: (value: 'order'|'return'|'rma') => this;
|
|
2085
2086
|
/** Payment amount. */
|
|
2086
|
-
value: (value:
|
|
2087
|
+
value: (value: number) => this;
|
|
2087
2088
|
/** Number of a bank account to which a payment is sent. */
|
|
2088
2089
|
account: (value: string) => this;
|
|
2089
2090
|
type: (value: 'payment'|'advance'|'repayment'|'fee') => this;
|
|
@@ -2105,7 +2106,7 @@ export interface PutPaymentsRequest extends Gateway {
|
|
|
2105
2106
|
/** Payment method ID. Check getPaymentForms. */
|
|
2106
2107
|
paymentFormId: (value: number|string) => this;
|
|
2107
2108
|
/** Refund value. */
|
|
2108
|
-
value: (value:
|
|
2109
|
+
value: (value: number) => this;
|
|
2109
2110
|
/** Registering date. */
|
|
2110
2111
|
accountingDate: (value: string) => this;
|
|
2111
2112
|
/** Number of a bank account to which a payment is sent. */
|
|
@@ -2124,13 +2125,13 @@ export interface GetPaymentsProfilesRequest extends PagableGateway<GetPaymentsPr
|
|
|
2124
2125
|
resultsLimit: (value: number|string) => this;
|
|
2125
2126
|
}
|
|
2126
2127
|
|
|
2127
|
-
export interface PostPaymentsRepaymentRequest extends Gateway {
|
|
2128
|
+
export interface PostPaymentsRepaymentRequest extends Gateway<PostPaymentsRepaymentResponse, RequestParams.PostPaymentsRepaymentParams> {
|
|
2128
2129
|
/** Returns ID. */
|
|
2129
2130
|
source_id: (value: number|string) => this;
|
|
2130
2131
|
/** Defines payment category. For the payments regarding returns, enter 'return'. */
|
|
2131
2132
|
source_type: (value: string) => this;
|
|
2132
2133
|
/** Refund value. */
|
|
2133
|
-
value: (value:
|
|
2134
|
+
value: (value: number) => this;
|
|
2134
2135
|
/** Payment method ID. Check getPaymentForms. */
|
|
2135
2136
|
payment_form_id: (value: number|string) => this;
|
|
2136
2137
|
/** Number of a bank account to which a payment is sent. */
|
|
@@ -2138,26 +2139,26 @@ export interface PostPaymentsRepaymentRequest extends Gateway {
|
|
|
2138
2139
|
/** Customer account. */
|
|
2139
2140
|
client_account: (value: string) => this;
|
|
2140
2141
|
/** Other. */
|
|
2141
|
-
other: (value:
|
|
2142
|
+
other: (value: RequestParams.PostPaymentsRepaymentParams["other"]) => this;
|
|
2142
2143
|
}
|
|
2143
2144
|
|
|
2144
2145
|
export interface GetProductsSKUbyBarcodeRequest extends Gateway<GetProductsSKUbyBarcodeResponse> {
|
|
2145
2146
|
/** List of sought products by indexes. */
|
|
2146
2147
|
productIndices: (value: string|string[]) => this;
|
|
2147
2148
|
/** Search for products only by IAI code */
|
|
2148
|
-
searchOnlyInCodeIai: (value:
|
|
2149
|
+
searchOnlyInCodeIai: (value: boolean) => this;
|
|
2149
2150
|
}
|
|
2150
2151
|
|
|
2151
|
-
export interface PutProductsAttachmentsRequest extends AppendableGateway<PutProductsAttachmentsRequest> {
|
|
2152
|
-
productsAttachments: (value:
|
|
2152
|
+
export interface PutProductsAttachmentsRequest extends AppendableGateway<PutProductsAttachmentsRequest, PutProductsAttachmentsResponse, RequestParams.PutProductsAttachmentsParams> {
|
|
2153
|
+
productsAttachments: (value: RequestParams.PutProductsAttachmentsParams["productsAttachments"]) => this;
|
|
2153
2154
|
/** Stock keeping unit. */
|
|
2154
|
-
productIdent: (productIdent:
|
|
2155
|
+
productIdent: (productIdent: RequestParams.PutProductsAttachmentsParams["productsAttachments"][number]["productIdent"]) => this
|
|
2155
2156
|
/** Product attachments list. */
|
|
2156
|
-
attachments: (attachments:
|
|
2157
|
+
attachments: (attachments: RequestParams.PutProductsAttachmentsParams["productsAttachments"][number]["attachments"]) => this
|
|
2157
2158
|
/** List of product's virtual attachments. */
|
|
2158
|
-
virtualAttachments: (virtualAttachments:
|
|
2159
|
+
virtualAttachments: (virtualAttachments: RequestParams.PutProductsAttachmentsParams["productsAttachments"][number]["virtualAttachments"]) => this
|
|
2159
2160
|
/** Information on error that occurred during gate call. */
|
|
2160
|
-
errors: (errors:
|
|
2161
|
+
errors: (errors: RequestParams.PutProductsAttachmentsParams["productsAttachments"][number]["errors"]) => this
|
|
2161
2162
|
/** Flag indicating if there are errors in results of attachments settings. */
|
|
2162
2163
|
attachmentsErrorsOccurred: (attachmentsErrorsOccurred: boolean) => this
|
|
2163
2164
|
/** Flag indicating if there are errors in results of virtual attachments settings. */
|
|
@@ -2165,7 +2166,7 @@ export interface PutProductsAttachmentsRequest extends AppendableGateway<PutProd
|
|
|
2165
2166
|
productId: (value: number|string) => this;
|
|
2166
2167
|
}
|
|
2167
2168
|
|
|
2168
|
-
export interface GetProductsAuctionsRequest extends PagableGateway<GetProductsAuctionsRequest,GetProductsAuctionsResponse> {
|
|
2169
|
+
export interface GetProductsAuctionsRequest extends PagableGateway<GetProductsAuctionsRequest, GetProductsAuctionsResponse> {
|
|
2169
2170
|
identType: (value: 'id'|'index'|'codeExtern'|'codeProducer') => this;
|
|
2170
2171
|
/** Products list. */
|
|
2171
2172
|
products: (value: string|string[]) => this;
|
|
@@ -2216,7 +2217,7 @@ export interface PutProductsBrandsFilterRequest extends AppendableGateway<PutPro
|
|
|
2216
2217
|
filterDefaultEnabled: (filterDefaultEnabled: 'y'|'n') => this
|
|
2217
2218
|
}
|
|
2218
2219
|
|
|
2219
|
-
export interface GetProductsBrandsRequest extends PagableGateway<GetProductsBrandsRequest,GetProductsBrandsResponse> {
|
|
2220
|
+
export interface GetProductsBrandsRequest extends PagableGateway<GetProductsBrandsRequest, GetProductsBrandsResponse> {
|
|
2220
2221
|
/** Result page number. */
|
|
2221
2222
|
results_page: (value: number|string) => this;
|
|
2222
2223
|
/** Number of results on page. */
|
|
@@ -2292,7 +2293,7 @@ export interface PutProductsBundlesRenewRequest extends AppendableGateway<PutPro
|
|
|
2292
2293
|
bundleIdent: (bundleIdent: JSObject) => this
|
|
2293
2294
|
}
|
|
2294
2295
|
|
|
2295
|
-
export interface GetProductsCategoriesRequest extends PagableGateway<GetProductsCategoriesRequest,GetProductsCategoriesResponse> {
|
|
2296
|
+
export interface GetProductsCategoriesRequest extends PagableGateway<GetProductsCategoriesRequest, GetProductsCategoriesResponse> {
|
|
2296
2297
|
/** List of product category identifiers in the panel */
|
|
2297
2298
|
ids: (value: number|string|number[]|string[]) => this;
|
|
2298
2299
|
/** Array of languages categories names should be returned in. "Defaults" value returns categories names in store default language. Not using languages parameter causes a situation, that categories names are returned in all available languages. */
|
|
@@ -2305,9 +2306,9 @@ export interface GetProductsCategoriesRequest extends PagableGateway<GetProducts
|
|
|
2305
2306
|
return_last_changed_time: (value: string) => this;
|
|
2306
2307
|
}
|
|
2307
2308
|
|
|
2308
|
-
export interface PutProductsCategoriesRequest extends AppendableGateway<PutProductsCategoriesRequest> {
|
|
2309
|
+
export interface PutProductsCategoriesRequest extends AppendableGateway<PutProductsCategoriesRequest, PutProductsCategoriesResponse, RequestParams.PutProductsCategoriesParams> {
|
|
2309
2310
|
/** List of categories in which sought products are present. */
|
|
2310
|
-
categories: (value:
|
|
2311
|
+
categories: (value: RequestParams.PutProductsCategoriesParams["categories"]) => this;
|
|
2311
2312
|
/** Category id. */
|
|
2312
2313
|
id: (id: number|string) => this
|
|
2313
2314
|
/** Parent category ID. */
|
|
@@ -2317,10 +2318,10 @@ export interface PutProductsCategoriesRequest extends AppendableGateway<PutProdu
|
|
|
2317
2318
|
/** Operation code. Allowed values. "add" - adds new category, "edit" - edits existing category, "del" - deletes existing category. */
|
|
2318
2319
|
operation: (operation: string) => this
|
|
2319
2320
|
/** */
|
|
2320
|
-
lang_data: (lang_data:
|
|
2321
|
+
lang_data: (lang_data: RequestParams.PutProductsCategoriesParams["categories"][number]["lang_data"]) => this
|
|
2321
2322
|
}
|
|
2322
2323
|
|
|
2323
|
-
export interface SearchProductsCategoriesIdosellRequest extends PagableGateway<SearchProductsCategoriesIdosellRequest,
|
|
2324
|
+
export interface SearchProductsCategoriesIdosellRequest extends PagableGateway<SearchProductsCategoriesIdosellRequest, SearchProductsCategoriesIdosellResponse> {
|
|
2324
2325
|
/** List of languages */
|
|
2325
2326
|
languagesIds: (value: string|string[]) => this;
|
|
2326
2327
|
/** Number of IdoSell Categories identifiers */
|
|
@@ -2389,12 +2390,12 @@ export interface PutProductsCollectionsRenewRequest extends AppendableGateway<Pu
|
|
|
2389
2390
|
collectionIdent: (collectionIdent: JSObject) => this
|
|
2390
2391
|
}
|
|
2391
2392
|
|
|
2392
|
-
export interface SearchProductsDeliveryTimeRequest extends AppendableGateway<SearchProductsDeliveryTimeRequest, SearchProductsDeliveryTimeResponse> {
|
|
2393
|
+
export interface SearchProductsDeliveryTimeRequest extends AppendableGateway<SearchProductsDeliveryTimeRequest, SearchProductsDeliveryTimeResponse, RequestParams.SearchProductsDeliveryTimeParams> {
|
|
2393
2394
|
/** Stock ID */
|
|
2394
2395
|
stockId: (value: number|string) => this;
|
|
2395
2396
|
/** Should products be prepared for personal collection? */
|
|
2396
|
-
isCollectionInPerson: (value:
|
|
2397
|
-
products: (value:
|
|
2397
|
+
isCollectionInPerson: (value: boolean) => this;
|
|
2398
|
+
products: (value: RequestParams.SearchProductsDeliveryTimeParams["products"]) => this;
|
|
2398
2399
|
/** Product Id */
|
|
2399
2400
|
productId: (productId: number|string) => this
|
|
2400
2401
|
/** Size identifier */
|
|
@@ -2429,7 +2430,7 @@ export interface PutProductsDescriptionsRequest extends AppendableGateway<PutPro
|
|
|
2429
2430
|
productAuctionDescriptionsData: (productAuctionDescriptionsData: Array<JSObject>) => this
|
|
2430
2431
|
productId: (value: number|string) => this;
|
|
2431
2432
|
/** Set various types of names or descriptions to the product */
|
|
2432
|
-
setText: (text: string, type?: "productName"|"productAuctionName"|"productPriceComparerName"|"productDescription"|"productLongDescription"|"productMetaTitle"|"productMetaDescription"|"productMetaKeywords"
|
|
2433
|
+
setText: (text: string, type?: "productName"|"productAuctionName"|"productPriceComparerName"|"productDescription"|"productLongDescription"|"productMetaTitle"|"productMetaDescription"|"productMetaKeywords", language?: string, shopId?: number|string) => this;
|
|
2433
2434
|
}
|
|
2434
2435
|
|
|
2435
2436
|
export interface PutProductsGroupsMainProductRequest extends AppendableGateway<PutProductsGroupsMainProductRequest> {
|
|
@@ -2452,9 +2453,9 @@ export interface PutProductsGroupsSettingsRequest extends AppendableGateway<PutP
|
|
|
2452
2453
|
/** */
|
|
2453
2454
|
productIdent: (productIdent: JSObject) => this
|
|
2454
2455
|
/** Display on the product list in the panel. */
|
|
2455
|
-
displayInPanel: (displayInPanel: '
|
|
2456
|
+
displayInPanel: (displayInPanel: 'firstAvailable'|'all') => this
|
|
2456
2457
|
/** Display on a product list on the page. */
|
|
2457
|
-
displayOnPage: (displayOnPage: '
|
|
2458
|
+
displayOnPage: (displayOnPage: 'firstAvailable'|'all'|'specified') => this
|
|
2458
2459
|
/** Selected product in the group. */
|
|
2459
2460
|
specifiedProductIdent: (specifiedProductIdent: JSObject) => this
|
|
2460
2461
|
productId: (value: number|string) => this;
|
|
@@ -2620,18 +2621,18 @@ export interface PutProductsOmnibusPricesRequest extends AppendableGateway<PutPr
|
|
|
2620
2621
|
/** Strikethrough price settings for the page. */
|
|
2621
2622
|
shops: (shops: Array<JSObject>) => this
|
|
2622
2623
|
/** Set product identifiers */
|
|
2623
|
-
productId: (productId: number|string, type?: 'id'|'index'|'codeExtern'|'codeProducer'
|
|
2624
|
+
productId: (productId: number|string, type?: 'id'|'index'|'codeExtern'|'codeProducer') => this;
|
|
2624
2625
|
/** Set retail or wholesale price */
|
|
2625
|
-
setPrice: (price: number, wholesale?: boolean
|
|
2626
|
+
setPrice: (price: number, wholesale?: boolean) => this;
|
|
2626
2627
|
/** Set mode to automatic */
|
|
2627
|
-
mode: (automatic: boolean
|
|
2628
|
+
mode: (automatic: boolean) => this;
|
|
2628
2629
|
}
|
|
2629
2630
|
|
|
2630
2631
|
export interface DeleteProductsOpinionsRequest extends Gateway {
|
|
2631
2632
|
id: (value: number|string) => this;
|
|
2632
2633
|
}
|
|
2633
2634
|
|
|
2634
|
-
export interface GetProductsOpinionsRequest extends PagableGateway<GetProductsOpinionsRequest,GetProductsOpinionsResponse> {
|
|
2635
|
+
export interface GetProductsOpinionsRequest extends PagableGateway<GetProductsOpinionsRequest, GetProductsOpinionsResponse> {
|
|
2635
2636
|
/** Review identification */
|
|
2636
2637
|
opinion: (value: JSObject) => this;
|
|
2637
2638
|
/** Products list. */
|
|
@@ -2702,7 +2703,7 @@ export interface PutProductsOpinionsRequest extends Gateway {
|
|
|
2702
2703
|
shopAnswer: (value: string) => this;
|
|
2703
2704
|
picture: (value: string) => this;
|
|
2704
2705
|
/** Opinion confirmed with purchase */
|
|
2705
|
-
opinionConfirmedByPurchase: (value:
|
|
2706
|
+
opinionConfirmedByPurchase: (value: boolean) => this;
|
|
2706
2707
|
}
|
|
2707
2708
|
|
|
2708
2709
|
export interface GetProductsOpinionsRateRequest extends Gateway {
|
|
@@ -2740,15 +2741,15 @@ export interface PutProductsParametersRequest extends AppendableGateway<PutProdu
|
|
|
2740
2741
|
context_value_id: (context_value_id: string) => this
|
|
2741
2742
|
}
|
|
2742
2743
|
|
|
2743
|
-
export interface SearchProductsParametersRequest extends PagableGateway<SearchProductsParametersRequest,SearchProductsParametersResponse> {
|
|
2744
|
+
export interface SearchProductsParametersRequest extends PagableGateway<SearchProductsParametersRequest, SearchProductsParametersResponse, RequestParams.SearchProductsParametersParams> {
|
|
2744
2745
|
/** List of identifiers */
|
|
2745
2746
|
ids: (value: number|string|number[]|string[]) => this;
|
|
2746
2747
|
/** Element text ID - can be entered instead of "id". */
|
|
2747
|
-
textIds: (value:
|
|
2748
|
+
textIds: (value: RequestParams.SearchProductsParametersParams["textIds"]) => this;
|
|
2748
2749
|
/** List of languages */
|
|
2749
2750
|
languagesIds: (value: string|string[]) => this;
|
|
2750
2751
|
/** Whether to return a list of parameter value IDs */
|
|
2751
|
-
parameterValueIds: (value:
|
|
2752
|
+
parameterValueIds: (value: boolean) => this;
|
|
2752
2753
|
/** Page with results number. Numeration starts from 0 */
|
|
2753
2754
|
resultsPage: (value: number|string) => this;
|
|
2754
2755
|
/** Number of results on page. Value from 1 to 100 */
|
|
@@ -2769,13 +2770,13 @@ export interface GetProductsRequest extends Gateway<SearchProductsResponse> {
|
|
|
2769
2770
|
productIds: (value: string|string[]) => this;
|
|
2770
2771
|
}
|
|
2771
2772
|
|
|
2772
|
-
export interface PostProductsRequest extends AppendableGateway<PostProductsRequest> {
|
|
2773
|
+
export interface PostProductsRequest extends AppendableGateway<PostProductsRequest, PostProductsResponse, RequestParams.PostProductsParams> {
|
|
2773
2774
|
/** Settings */
|
|
2774
|
-
settings: (value:
|
|
2775
|
+
settings: (value: RequestParams.PostProductsParams["settings"]) => this;
|
|
2775
2776
|
/** Icon and photos settings */
|
|
2776
|
-
picturesSettings: (value:
|
|
2777
|
+
picturesSettings: (value: RequestParams.PostProductsParams["picturesSettings"]) => this;
|
|
2777
2778
|
/** Products list. */
|
|
2778
|
-
products: (value:
|
|
2779
|
+
products: (value: RequestParams.PostProductsParams["products"]) => this;
|
|
2779
2780
|
/** Product IAI code */
|
|
2780
2781
|
productId: (productId: number|string) => this
|
|
2781
2782
|
/** External product system code for size. */
|
|
@@ -2817,7 +2818,7 @@ export interface PostProductsRequest extends AppendableGateway<PostProductsReque
|
|
|
2817
2818
|
/** Optional element, that determines prices edition mode. Default value is "amount_set", when indicated element is omitted in API gate call.. Allowed values "amount_set" - sets product prices to desired value (default mode), "amount_diff" - sets sum difference between prices set (adds or subtracts entered sum from the current price), "percent_diff" - sets percentage difference between prices set (adds or subtracts entered percent from the current price). */
|
|
2818
2819
|
priceChangeMode: (priceChangeMode: string) => this
|
|
2819
2820
|
/** The JavaScript formula calculating prices */
|
|
2820
|
-
priceFormula: (priceFormula:
|
|
2821
|
+
priceFormula: (priceFormula: RequestParams.PostProductsParams["products"][number]["priceFormula"]) => this
|
|
2821
2822
|
/** Gross price */
|
|
2822
2823
|
productRetailPrice: (productRetailPrice: number) => this
|
|
2823
2824
|
/** Wholesale price */
|
|
@@ -2833,9 +2834,9 @@ export interface PostProductsRequest extends AppendableGateway<PostProductsReque
|
|
|
2833
2834
|
/** Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
2834
2835
|
productVatFree: (productVatFree: string) => this
|
|
2835
2836
|
/** Different prices for price comparison websites. */
|
|
2836
|
-
productPriceComparisonSitesPrices: (productPriceComparisonSitesPrices:
|
|
2837
|
+
productPriceComparisonSitesPrices: (productPriceComparisonSitesPrices: RequestParams.PostProductsParams["products"][number]["productPriceComparisonSitesPrices"]) => this
|
|
2837
2838
|
/** Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes. */
|
|
2838
|
-
productEnableInPos: (productEnableInPos:
|
|
2839
|
+
productEnableInPos: (productEnableInPos: "n" | "y") => this
|
|
2839
2840
|
/** Required advance payment in percents */
|
|
2840
2841
|
productAdvancePrice: (productAdvancePrice: number) => this
|
|
2841
2842
|
/** Annotation. */
|
|
@@ -2847,17 +2848,17 @@ export interface PostProductsRequest extends AppendableGateway<PostProductsReque
|
|
|
2847
2848
|
/** Product visibility. Allowed values "y" - product visible, "n" - product not visible. */
|
|
2848
2849
|
productInVisible: (productInVisible: string) => this
|
|
2849
2850
|
/** Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
|
|
2850
|
-
productInPersistent: (productInPersistent:
|
|
2851
|
+
productInPersistent: (productInPersistent: "y" | "n") => this
|
|
2851
2852
|
/** Bit mask of shop IDs. Mask for indicated store is calculated on basis of following formula: 2^(store_ID - 1). If the product should be available in more than one shop, the masks should be summed up. */
|
|
2852
2853
|
shopsMask: (shopsMask: number|string) => this
|
|
2853
2854
|
/** Complex rating Available values: "0" - no, "1" - yes. */
|
|
2854
2855
|
productComplexNotes: (productComplexNotes: number|string) => this
|
|
2855
2856
|
/** Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - yes (selected), "n" - invisible. */
|
|
2856
|
-
productInExportToPriceComparisonSites: (productInExportToPriceComparisonSites:
|
|
2857
|
+
productInExportToPriceComparisonSites: (productInExportToPriceComparisonSites: "y" | "selected" | "n") => this
|
|
2857
2858
|
/** Selection of comparison sites for which the product visibility will be changed */
|
|
2858
|
-
priceComparisonSites: (priceComparisonSites:
|
|
2859
|
+
priceComparisonSites: (priceComparisonSites: RequestParams.PostProductsParams["products"][number]["priceComparisonSites"]) => this
|
|
2859
2860
|
/** Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
|
|
2860
|
-
productInExportToAmazonMarketplace: (productInExportToAmazonMarketplace:
|
|
2861
|
+
productInExportToAmazonMarketplace: (productInExportToAmazonMarketplace: "y" | "selected" | "n") => this
|
|
2861
2862
|
/** Availability profile ID. */
|
|
2862
2863
|
availableProfile: (availableProfile: number|string) => this
|
|
2863
2864
|
/** Discount profile ID */
|
|
@@ -2877,41 +2878,41 @@ export interface PostProductsRequest extends AppendableGateway<PostProductsReque
|
|
|
2877
2878
|
/** List of photos descriptions */
|
|
2878
2879
|
productDescriptionPictures: (productDescriptionPictures: string|string[]) => this
|
|
2879
2880
|
/** Reduced price */
|
|
2880
|
-
productPromotion: (productPromotion:
|
|
2881
|
+
productPromotion: (productPromotion: RequestParams.PostProductsParams["products"][number]["productPromotion"]) => this
|
|
2881
2882
|
/** Discount for shop. */
|
|
2882
|
-
productDiscount: (productDiscount:
|
|
2883
|
+
productDiscount: (productDiscount: RequestParams.PostProductsParams["products"][number]["productDiscount"]) => this
|
|
2883
2884
|
/** Distinguished product in store. */
|
|
2884
|
-
productDistinguished: (productDistinguished:
|
|
2885
|
+
productDistinguished: (productDistinguished: RequestParams.PostProductsParams["products"][number]["productDistinguished"]) => this
|
|
2885
2886
|
/** Special product in store. */
|
|
2886
|
-
productSpecial: (productSpecial:
|
|
2887
|
+
productSpecial: (productSpecial: RequestParams.PostProductsParams["products"][number]["productSpecial"]) => this
|
|
2887
2888
|
/** Parameters (distinguished). */
|
|
2888
|
-
productParametersDistinction: (productParametersDistinction:
|
|
2889
|
+
productParametersDistinction: (productParametersDistinction: RequestParams.PostProductsParams["products"][number]["productParametersDistinction"]) => this
|
|
2889
2890
|
/** List of products recommended with this product */
|
|
2890
|
-
associatedProducts: (associatedProducts:
|
|
2891
|
+
associatedProducts: (associatedProducts: RequestParams.PostProductsParams["products"][number]["associatedProducts"]) => this
|
|
2891
2892
|
/** Sizes available for products data. */
|
|
2892
|
-
productSizes: (productSizes:
|
|
2893
|
+
productSizes: (productSizes: RequestParams.PostProductsParams["products"][number]["productSizes"]) => this
|
|
2893
2894
|
/** Data concerning attributes dependent on indicated stores with particular product assigned. */
|
|
2894
|
-
productShopsAttributes: (productShopsAttributes:
|
|
2895
|
+
productShopsAttributes: (productShopsAttributes: RequestParams.PostProductsParams["products"][number]["productShopsAttributes"]) => this
|
|
2895
2896
|
/** Products subscription settings. */
|
|
2896
|
-
subscription: (subscription:
|
|
2897
|
+
subscription: (subscription: RequestParams.PostProductsParams["products"][number]["subscription"]) => this
|
|
2897
2898
|
/** Product name. */
|
|
2898
|
-
productNames: (productNames:
|
|
2899
|
+
productNames: (productNames: RequestParams.PostProductsParams["products"][number]["productNames"]) => this
|
|
2899
2900
|
/** */
|
|
2900
|
-
productDescriptions: (productDescriptions:
|
|
2901
|
+
productDescriptions: (productDescriptions: RequestParams.PostProductsParams["products"][number]["productDescriptions"]) => this
|
|
2901
2902
|
/** Long product description */
|
|
2902
|
-
productLongDescriptions: (productLongDescriptions:
|
|
2903
|
+
productLongDescriptions: (productLongDescriptions: RequestParams.PostProductsParams["products"][number]["productLongDescriptions"]) => this
|
|
2903
2904
|
/** Product data for auction services */
|
|
2904
|
-
productAuctionDescriptionsData: (productAuctionDescriptionsData:
|
|
2905
|
+
productAuctionDescriptionsData: (productAuctionDescriptionsData: RequestParams.PostProductsParams["products"][number]["productAuctionDescriptionsData"]) => this
|
|
2905
2906
|
/** Product meta title */
|
|
2906
|
-
productMetaTitles: (productMetaTitles:
|
|
2907
|
+
productMetaTitles: (productMetaTitles: RequestParams.PostProductsParams["products"][number]["productMetaTitles"]) => this
|
|
2907
2908
|
/** Product meta description */
|
|
2908
|
-
productMetaDescriptions: (productMetaDescriptions:
|
|
2909
|
+
productMetaDescriptions: (productMetaDescriptions: RequestParams.PostProductsParams["products"][number]["productMetaDescriptions"]) => this
|
|
2909
2910
|
/** Product meta keywords. */
|
|
2910
|
-
productMetaKeywords: (productMetaKeywords:
|
|
2911
|
+
productMetaKeywords: (productMetaKeywords: RequestParams.PostProductsParams["products"][number]["productMetaKeywords"]) => this
|
|
2911
2912
|
/** #!AdresURLDlaTowaru!#. */
|
|
2912
|
-
productUrl: (productUrl:
|
|
2913
|
+
productUrl: (productUrl: RequestParams.PostProductsParams["products"][number]["productUrl"]) => this
|
|
2913
2914
|
/** Data on product groups (variants) */
|
|
2914
|
-
productVersion: (productVersion:
|
|
2915
|
+
productVersion: (productVersion: RequestParams.PostProductsParams["products"][number]["productVersion"]) => this
|
|
2915
2916
|
/** Currency ID */
|
|
2916
2917
|
currencyId: (currencyId: string) => this
|
|
2917
2918
|
/** Supplier ID. */
|
|
@@ -2919,34 +2920,34 @@ export interface PostProductsRequest extends AppendableGateway<PostProductsReque
|
|
|
2919
2920
|
/** This parameter is optional and it determines properties edition mode. Default value is "replace". Allowed values: "add" - adds properties to already existent ones, "delete" - removes properties of already existent ones, "delete_group" - removes properties from selected group, "replace" - overwrites properties already existent with new ones (default mode). */
|
|
2920
2921
|
productParametersDistinctionChangeMode: (productParametersDistinctionChangeMode: 'add'|'delete'|'delete_group'|'replace') => this
|
|
2921
2922
|
/** Product delivery time from the producer to the shop */
|
|
2922
|
-
productDeliveryTime: (productDeliveryTime:
|
|
2923
|
+
productDeliveryTime: (productDeliveryTime: RequestParams.PostProductsParams["products"][number]["productDeliveryTime"]) => this
|
|
2923
2924
|
/** Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
2924
|
-
productSumInBasket: (productSumInBasket:
|
|
2925
|
+
productSumInBasket: (productSumInBasket: "y" | "n") => this
|
|
2925
2926
|
/** Shipping, returns and complaints settings */
|
|
2926
|
-
dispatchSettings: (dispatchSettings:
|
|
2927
|
+
dispatchSettings: (dispatchSettings: RequestParams.PostProductsParams["products"][number]["dispatchSettings"]) => this
|
|
2927
2928
|
/** Standard unit settings */
|
|
2928
|
-
standardUnit: (standardUnit:
|
|
2929
|
+
standardUnit: (standardUnit: RequestParams.PostProductsParams["products"][number]["standardUnit"]) => this
|
|
2929
2930
|
/** Minimal number of products in an order */
|
|
2930
|
-
minQuantityPerOrder: (minQuantityPerOrder:
|
|
2931
|
+
minQuantityPerOrder: (minQuantityPerOrder: RequestParams.PostProductsParams["products"][number]["minQuantityPerOrder"]) => this
|
|
2931
2932
|
/** Dimensions and overall weight */
|
|
2932
|
-
productDimensions: (productDimensions:
|
|
2933
|
+
productDimensions: (productDimensions: RequestParams.PostProductsParams["products"][number]["productDimensions"]) => this
|
|
2933
2934
|
/** Responsible producer code */
|
|
2934
2935
|
responsibleProducerCode: (responsibleProducerCode: string) => this
|
|
2935
2936
|
/** Responsible person code */
|
|
2936
2937
|
responsiblePersonCode: (responsiblePersonCode: string) => this
|
|
2937
2938
|
/** Set various types of names or descriptions to the product */
|
|
2938
|
-
setText: (text: string, type?: "productName"|"productParamDescriptions"|"productLongDescription"|"productMetaTitle"|"productMetaDescription"|"productMetaKeyword"|"productAuctionName"|"productAuctionDescription"|"productAuctionAdditionalName"|"productNameInPriceComparer"
|
|
2939
|
+
setText: (text: string, type?: "productName"|"productParamDescriptions"|"productLongDescription"|"productMetaTitle"|"productMetaDescription"|"productMetaKeyword"|"productAuctionName"|"productAuctionDescription"|"productAuctionAdditionalName"|"productNameInPriceComparer", language?: string, shopId?: number|string) => this;
|
|
2939
2940
|
/** Sets product price by amount */
|
|
2940
|
-
setPrice: (value: number, type?: 'retail'|'wholesale'|'pos'|'minimal'|'strikethroughRetail'|'strikethroughWholesale'|'suggested'|'automaticCalculation'
|
|
2941
|
+
setPrice: (value: number, type?: 'retail'|'wholesale'|'pos'|'minimal'|'strikethroughRetail'|'strikethroughWholesale'|'suggested'|'automaticCalculation') => this;
|
|
2941
2942
|
}
|
|
2942
2943
|
|
|
2943
|
-
export interface PutProductsRequest extends AppendableGateway<PutProductsRequest> {
|
|
2944
|
+
export interface PutProductsRequest extends AppendableGateway<PutProductsRequest, PutProductsResponse, RequestParams.PutProductsParams> {
|
|
2944
2945
|
/** Settings */
|
|
2945
|
-
settings: (value:
|
|
2946
|
+
settings: (value: RequestParams.PutProductsParams["settings"]) => this;
|
|
2946
2947
|
/** Icon and photos settings */
|
|
2947
|
-
picturesSettings: (value:
|
|
2948
|
+
picturesSettings: (value: RequestParams.PutProductsParams["picturesSettings"]) => this;
|
|
2948
2949
|
/** Products list. */
|
|
2949
|
-
products: (value:
|
|
2950
|
+
products: (value: RequestParams.PutProductsParams["products"]) => this;
|
|
2950
2951
|
/** Product IAI code */
|
|
2951
2952
|
productId: (productId: number|string) => this
|
|
2952
2953
|
/** One of the unique, indexed product codes (IAI code / External system code / Producer code) */
|
|
@@ -3030,19 +3031,19 @@ export interface PutProductsRequest extends AppendableGateway<PutProductsRequest
|
|
|
3030
3031
|
/** Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
3031
3032
|
productVatFree: (productVatFree: string) => this
|
|
3032
3033
|
/** Different prices for price comparison websites. */
|
|
3033
|
-
productPriceComparisonSitesPrices: (productPriceComparisonSitesPrices:
|
|
3034
|
+
productPriceComparisonSitesPrices: (productPriceComparisonSitesPrices: RequestParams.PutProductsParams["products"][number]["productPriceComparisonSitesPrices"]) => this
|
|
3034
3035
|
/** Object determines if the product is available in POS sale Available values: "n" - no, "y" - yes. */
|
|
3035
|
-
productEnableInPos: (productEnableInPos:
|
|
3036
|
+
productEnableInPos: (productEnableInPos: "n" | "y") => this
|
|
3036
3037
|
/** Required advance payment in percents */
|
|
3037
3038
|
productAdvancePrice: (productAdvancePrice: number) => this
|
|
3038
3039
|
/** Annotation. */
|
|
3039
3040
|
productNote: (productNote: string) => this
|
|
3040
3041
|
/** Settings of hotspots display. */
|
|
3041
|
-
productHotspotsZones: (productHotspotsZones:
|
|
3042
|
+
productHotspotsZones: (productHotspotsZones: RequestParams.PutProductsParams["products"][number]["productHotspotsZones"]) => this
|
|
3042
3043
|
/** Loyalty points. */
|
|
3043
|
-
priceInPoints: (priceInPoints:
|
|
3044
|
+
priceInPoints: (priceInPoints: RequestParams.PutProductsParams["products"][number]["priceInPoints"]) => this
|
|
3044
3045
|
/** Loyalty points. */
|
|
3045
|
-
loyaltyPoints: (loyaltyPoints:
|
|
3046
|
+
loyaltyPoints: (loyaltyPoints: RequestParams.PutProductsParams["products"][number]["loyaltyPoints"]) => this
|
|
3046
3047
|
/** Weight. */
|
|
3047
3048
|
productWeight: (productWeight: number|string) => this
|
|
3048
3049
|
/** Product visibility. Allowed values "y" - product visible, "n" - product not visible. */
|
|
@@ -3054,9 +3055,9 @@ export interface PutProductsRequest extends AppendableGateway<PutProductsRequest
|
|
|
3054
3055
|
/** Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - Selected, "assign_selected" - Enable the visibility of the product in the export to price comparison sites passed in the priceComparisonSites node. Price comparison sites previously assigned to the commodity will be retained, "unassign_selected" - Disable product visibility in exports to price comparison sites passed in the priceComparisonSites node, "n" - invisible. */
|
|
3055
3056
|
productInExportToPriceComparisonSites: (productInExportToPriceComparisonSites: 'y'|'selected'|'n') => this
|
|
3056
3057
|
/** Selection of comparison sites for which the product visibility will be changed */
|
|
3057
|
-
priceComparisonSites: (priceComparisonSites:
|
|
3058
|
+
priceComparisonSites: (priceComparisonSites: RequestParams.PutProductsParams["products"][number]["priceComparisonSites"]) => this
|
|
3058
3059
|
/** Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
|
|
3059
|
-
productInExportToAmazonMarketplace: (productInExportToAmazonMarketplace:
|
|
3060
|
+
productInExportToAmazonMarketplace: (productInExportToAmazonMarketplace: "y" | "selected" | "n") => this
|
|
3060
3061
|
/** Array */
|
|
3061
3062
|
exportToAmazonMarketplacesList: (exportToAmazonMarketplacesList: string|string[]) => this
|
|
3062
3063
|
/** Export sizes to Amazon: Available values: "y" - all, "n" - leave without change. */
|
|
@@ -3076,7 +3077,7 @@ export interface PutProductsRequest extends AppendableGateway<PutProductsRequest
|
|
|
3076
3077
|
/** Name of warranty for indicated product. */
|
|
3077
3078
|
warrantyName: (warrantyName: string) => this
|
|
3078
3079
|
/** The JavaScript formula calculating prices */
|
|
3079
|
-
priceFormula: (priceFormula:
|
|
3080
|
+
priceFormula: (priceFormula: RequestParams.PutProductsParams["products"][number]["priceFormula"]) => this
|
|
3080
3081
|
/** Size chart ID */
|
|
3081
3082
|
sizeChartId: (sizeChartId: number|string) => this
|
|
3082
3083
|
/** Size chart name */
|
|
@@ -3084,7 +3085,7 @@ export interface PutProductsRequest extends AppendableGateway<PutProductsRequest
|
|
|
3084
3085
|
/** Priority. Allowed values from 1 to 10. */
|
|
3085
3086
|
productPriority: (productPriority: number|string) => this
|
|
3086
3087
|
/** Product priority in menu node. */
|
|
3087
|
-
productPriorityInMenuNodes: (productPriorityInMenuNodes:
|
|
3088
|
+
productPriorityInMenuNodes: (productPriorityInMenuNodes: RequestParams.PutProductsParams["products"][number]["productPriorityInMenuNodes"]) => this
|
|
3088
3089
|
/** Product icon link. */
|
|
3089
3090
|
productIconLink: (productIconLink: string) => this
|
|
3090
3091
|
/** Photo without background. */
|
|
@@ -3092,67 +3093,67 @@ export interface PutProductsRequest extends AppendableGateway<PutProductsRequest
|
|
|
3092
3093
|
/** Icon for a product group. */
|
|
3093
3094
|
productGroupIconLink: (productGroupIconLink: string) => this
|
|
3094
3095
|
/** List of product photos */
|
|
3095
|
-
productPictures: (productPictures:
|
|
3096
|
+
productPictures: (productPictures: RequestParams.PutProductsParams["products"][number]["productPictures"]) => this
|
|
3096
3097
|
/** List of a product's photos with indication of a particular number of the photo. */
|
|
3097
|
-
productPicturesReplace: (productPicturesReplace:
|
|
3098
|
+
productPicturesReplace: (productPicturesReplace: RequestParams.PutProductsParams["products"][number]["productPicturesReplace"]) => this
|
|
3098
3099
|
/** Reduced price */
|
|
3099
|
-
productPromotion: (productPromotion:
|
|
3100
|
+
productPromotion: (productPromotion: RequestParams.PutProductsParams["products"][number]["productPromotion"]) => this
|
|
3100
3101
|
/** Discount for shop. */
|
|
3101
|
-
productDiscount: (productDiscount:
|
|
3102
|
+
productDiscount: (productDiscount: RequestParams.PutProductsParams["products"][number]["productDiscount"]) => this
|
|
3102
3103
|
/** Distinguished product in store. */
|
|
3103
|
-
productDistinguished: (productDistinguished:
|
|
3104
|
+
productDistinguished: (productDistinguished: RequestParams.PutProductsParams["products"][number]["productDistinguished"]) => this
|
|
3104
3105
|
/** Special product in store. */
|
|
3105
|
-
productSpecial: (productSpecial:
|
|
3106
|
+
productSpecial: (productSpecial: RequestParams.PutProductsParams["products"][number]["productSpecial"]) => this
|
|
3106
3107
|
/** Parameters (distinguished). */
|
|
3107
|
-
productParametersDistinction: (productParametersDistinction:
|
|
3108
|
+
productParametersDistinction: (productParametersDistinction: RequestParams.PutProductsParams["products"][number]["productParametersDistinction"]) => this
|
|
3108
3109
|
/** Configuration parameters */
|
|
3109
|
-
parametersConfigurable: (parametersConfigurable:
|
|
3110
|
+
parametersConfigurable: (parametersConfigurable: RequestParams.PutProductsParams["products"][number]["parametersConfigurable"]) => this
|
|
3110
3111
|
/** List of products recommended with this product */
|
|
3111
|
-
associatedProducts: (associatedProducts:
|
|
3112
|
+
associatedProducts: (associatedProducts: RequestParams.PutProductsParams["products"][number]["associatedProducts"]) => this
|
|
3112
3113
|
/** Sizes available for products data. */
|
|
3113
|
-
productSizes: (productSizes:
|
|
3114
|
+
productSizes: (productSizes: RequestParams.PutProductsParams["products"][number]["productSizes"]) => this
|
|
3114
3115
|
/** Product attachments list. */
|
|
3115
|
-
attachments: (attachments:
|
|
3116
|
+
attachments: (attachments: RequestParams.PutProductsParams["products"][number]["attachments"]) => this
|
|
3116
3117
|
/** The list of attachments to be deleted. */
|
|
3117
|
-
removeAttachments: (removeAttachments:
|
|
3118
|
+
removeAttachments: (removeAttachments: RequestParams.PutProductsParams["products"][number]["removeAttachments"]) => this
|
|
3118
3119
|
/** Do you want to delete attachments for digital files. */
|
|
3119
3120
|
virtualAttachmentsToRemove: (virtualAttachmentsToRemove: boolean) => this
|
|
3120
3121
|
/** List of product's virtual attachments. */
|
|
3121
|
-
virtualAttachments: (virtualAttachments:
|
|
3122
|
+
virtualAttachments: (virtualAttachments: RequestParams.PutProductsParams["products"][number]["virtualAttachments"]) => this
|
|
3122
3123
|
/** Operation, that will be performed on attachments to product. */
|
|
3123
3124
|
attachmentOperationValues: (attachmentOperationValues: 'edit'|'add'|'remove') => this
|
|
3124
3125
|
/** Data concerning attributes dependent on indicated stores with particular product assigned. */
|
|
3125
|
-
productShopsAttributes: (productShopsAttributes:
|
|
3126
|
+
productShopsAttributes: (productShopsAttributes: RequestParams.PutProductsParams["products"][number]["productShopsAttributes"]) => this
|
|
3126
3127
|
/** Products subscription settings. */
|
|
3127
|
-
subscription: (subscription:
|
|
3128
|
+
subscription: (subscription: RequestParams.PutProductsParams["products"][number]["subscription"]) => this
|
|
3128
3129
|
/** Product name. */
|
|
3129
|
-
productNames: (productNames:
|
|
3130
|
+
productNames: (productNames: RequestParams.PutProductsParams["products"][number]["productNames"]) => this
|
|
3130
3131
|
/** DEPRECATED. This parameter is deprecated. Product name for online auctions. */
|
|
3131
|
-
productNamesInAuction: (productNamesInAuction:
|
|
3132
|
+
productNamesInAuction: (productNamesInAuction: RequestParams.PutProductsParams["products"][number]["productNamesInAuction"]) => this
|
|
3132
3133
|
/** Product name for price comparison websites. */
|
|
3133
|
-
productNamesInPriceComparer: (productNamesInPriceComparer:
|
|
3134
|
+
productNamesInPriceComparer: (productNamesInPriceComparer: RequestParams.PutProductsParams["products"][number]["productNamesInPriceComparer"]) => this
|
|
3134
3135
|
/** Product short description */
|
|
3135
|
-
productParamDescriptions: (productParamDescriptions:
|
|
3136
|
+
productParamDescriptions: (productParamDescriptions: RequestParams.PutProductsParams["products"][number]["productParamDescriptions"]) => this
|
|
3136
3137
|
/** Long product description */
|
|
3137
|
-
productLongDescriptions: (productLongDescriptions:
|
|
3138
|
+
productLongDescriptions: (productLongDescriptions: RequestParams.PutProductsParams["products"][number]["productLongDescriptions"]) => this
|
|
3138
3139
|
/** DEPRECATED. This parameter is deprecated. Product description for marketplaces. */
|
|
3139
|
-
productLongDescriptionsInAuction: (productLongDescriptionsInAuction:
|
|
3140
|
+
productLongDescriptionsInAuction: (productLongDescriptionsInAuction: RequestParams.PutProductsParams["products"][number]["productLongDescriptionsInAuction"]) => this
|
|
3140
3141
|
/** Product data for auction services */
|
|
3141
|
-
productAuctionDescriptionsData: (productAuctionDescriptionsData:
|
|
3142
|
+
productAuctionDescriptionsData: (productAuctionDescriptionsData: RequestParams.PutProductsParams["products"][number]["productAuctionDescriptionsData"]) => this
|
|
3142
3143
|
/** Product meta title */
|
|
3143
|
-
productMetaTitles: (productMetaTitles:
|
|
3144
|
+
productMetaTitles: (productMetaTitles: RequestParams.PutProductsParams["products"][number]["productMetaTitles"]) => this
|
|
3144
3145
|
/** Product meta description */
|
|
3145
|
-
productMetaDescriptions: (productMetaDescriptions:
|
|
3146
|
+
productMetaDescriptions: (productMetaDescriptions: RequestParams.PutProductsParams["products"][number]["productMetaDescriptions"]) => this
|
|
3146
3147
|
/** Product meta keywords. */
|
|
3147
|
-
productMetaKeywords: (productMetaKeywords:
|
|
3148
|
+
productMetaKeywords: (productMetaKeywords: RequestParams.PutProductsParams["products"][number]["productMetaKeywords"]) => this
|
|
3148
3149
|
/** URL for the product */
|
|
3149
|
-
productUrl: (productUrl:
|
|
3150
|
+
productUrl: (productUrl: RequestParams.PutProductsParams["products"][number]["productUrl"]) => this
|
|
3150
3151
|
/** Data on product groups (variants) */
|
|
3151
|
-
productVersion: (productVersion:
|
|
3152
|
+
productVersion: (productVersion: RequestParams.PutProductsParams["products"][number]["productVersion"]) => this
|
|
3152
3153
|
/** Currency ID */
|
|
3153
3154
|
currencyId: (currencyId: string) => this
|
|
3154
3155
|
/** Currency, in which product prices are stored. */
|
|
3155
|
-
productCurrenciesShops: (productCurrenciesShops:
|
|
3156
|
+
productCurrenciesShops: (productCurrenciesShops: RequestParams.PutProductsParams["products"][number]["productCurrenciesShops"]) => this
|
|
3156
3157
|
/** Supplier ID. */
|
|
3157
3158
|
delivererId: (delivererId: number|string) => this
|
|
3158
3159
|
/** Supplier name. */
|
|
@@ -3160,21 +3161,21 @@ export interface PutProductsRequest extends AppendableGateway<PutProductsRequest
|
|
|
3160
3161
|
/** This parameter is optional and it determines properties edition mode. Default value is "replace". Allowed values: "add" - adds properties to already existent ones, "delete" - removes properties of already existent ones, "delete_group" - removes properties from selected group, "replace" - overwrites properties already existent with new ones (default mode). */
|
|
3161
3162
|
productParametersDistinctionChangeMode: (productParametersDistinctionChangeMode: 'add'|'delete'|'delete_group'|'replace') => this
|
|
3162
3163
|
/** Product delivery time from the producer to the shop */
|
|
3163
|
-
productDeliveryTime: (productDeliveryTime:
|
|
3164
|
+
productDeliveryTime: (productDeliveryTime: RequestParams.PutProductsParams["products"][number]["productDeliveryTime"]) => this
|
|
3164
3165
|
/** Parameters. */
|
|
3165
|
-
productParameters: (productParameters:
|
|
3166
|
+
productParameters: (productParameters: RequestParams.PutProductsParams["products"][number]["productParameters"]) => this
|
|
3166
3167
|
/** */
|
|
3167
3168
|
clearProductParameters: (clearProductParameters: boolean) => this
|
|
3168
3169
|
/** Change parameter distinction. */
|
|
3169
|
-
changeParametersDistinction: (changeParametersDistinction:
|
|
3170
|
+
changeParametersDistinction: (changeParametersDistinction: RequestParams.PutProductsParams["products"][number]["changeParametersDistinction"]) => this
|
|
3170
3171
|
/** VAT rate change mode:. "change_gross" - changes the product gross price, leaving the net price unchanged, "change_net" - changes the net price, leaving the gross price unchanged (default mode). */
|
|
3171
3172
|
productPriceVatChangeMode: (productPriceVatChangeMode: 'change_net'|'change_gross') => this
|
|
3172
3173
|
/** An array of menu elements */
|
|
3173
|
-
productMenuItems: (productMenuItems:
|
|
3174
|
+
productMenuItems: (productMenuItems: RequestParams.PutProductsParams["products"][number]["productMenuItems"]) => this
|
|
3174
3175
|
/** Deletes all items assigned to the product of the selected menu */
|
|
3175
|
-
removeAllProductsAssignedToMenu: (removeAllProductsAssignedToMenu:
|
|
3176
|
+
removeAllProductsAssignedToMenu: (removeAllProductsAssignedToMenu: RequestParams.PutProductsParams["products"][number]["removeAllProductsAssignedToMenu"]) => this
|
|
3176
3177
|
/** Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
3177
|
-
productSumInBasket: (productSumInBasket:
|
|
3178
|
+
productSumInBasket: (productSumInBasket: "y" | "n") => this
|
|
3178
3179
|
/** Settings of prices for shop. Values allowed: "same_prices" - prices in each shop are the same, "different_prices" - prices in each shop are different. */
|
|
3179
3180
|
productShopsPricesConfig: (productShopsPricesConfig: 'same_prices'|'different_prices') => this
|
|
3180
3181
|
/** Price settings for POS. Allowed values: "pos_equals_retail" - sets POS price the same as retail price. Possible to set only if the "shops_prices_config" parameter is set to jest same_prices or there is only one shop in panel, "pos_notequals_retail" - Price for POS different than retail price, "not_available_in_pos" - Product not available for POS sales. "sizes_pos_price_as_base_price" - Remove prices for sizes and set a sale price which equals a basic price. */
|
|
@@ -3190,29 +3191,29 @@ export interface PutProductsRequest extends AppendableGateway<PutProductsRequest
|
|
|
3190
3191
|
/** Remove all unused sizes. */
|
|
3191
3192
|
removeAllUnusedProductSizes: (removeAllUnusedProductSizes: boolean) => this
|
|
3192
3193
|
/** Standard producer code. Available values: "auto" - Choose automatically, "GTIN14" - GTIN-14 "GTIN13" - GTIN-13 (EAN-13) "ISBN13" - GTIN-13 (ISBN-13) "GTIN12" - GTIN-12 (UPC-A) "ISBN10" - ISBN-10 "GTIN8" - GTIN-8 (EAN-8) "UPCE" - UPC-E "MPN" - MPN "other" - Other */
|
|
3193
|
-
producerCodesStandard: (producerCodesStandard: 'auto'|'
|
|
3194
|
+
producerCodesStandard: (producerCodesStandard: 'auto'|'GTIN14'|'GTIN13'|'ISBN13'|'GTIN12'|'ISBN10'|'GTIN8'|'UPCE'|'MPN'|'other') => this
|
|
3194
3195
|
/** JavaScript code displayed in the product page of the IdoSell Shop */
|
|
3195
|
-
javaScriptInTheItemCard: (javaScriptInTheItemCard:
|
|
3196
|
+
javaScriptInTheItemCard: (javaScriptInTheItemCard: RequestParams.PutProductsParams["products"][number]["javaScriptInTheItemCard"]) => this
|
|
3196
3197
|
/** Saving serial numbers Available values: "na" - not used, "optional" - Optional, "required" - required. */
|
|
3197
3198
|
serialNumbersOption: (serialNumbersOption: 'na'|'optional'|'required') => this
|
|
3198
3199
|
/** Shipping, returns and complaints settings */
|
|
3199
|
-
dispatchSettings: (dispatchSettings:
|
|
3200
|
+
dispatchSettings: (dispatchSettings: RequestParams.PutProductsParams["products"][number]["dispatchSettings"]) => this
|
|
3200
3201
|
/** Standard unit settings */
|
|
3201
|
-
standardUnit: (standardUnit:
|
|
3202
|
+
standardUnit: (standardUnit: RequestParams.PutProductsParams["products"][number]["standardUnit"]) => this
|
|
3202
3203
|
/** Minimal number of products in an order */
|
|
3203
|
-
minQuantityPerOrder: (minQuantityPerOrder:
|
|
3204
|
+
minQuantityPerOrder: (minQuantityPerOrder: RequestParams.PutProductsParams["products"][number]["minQuantityPerOrder"]) => this
|
|
3204
3205
|
/** */
|
|
3205
3206
|
dynamicPricingEnabled: (dynamicPricingEnabled: string) => this
|
|
3206
3207
|
/** The setting allows you to reset the inventory to zero */
|
|
3207
|
-
clearStockQuantities: (clearStockQuantities:
|
|
3208
|
+
clearStockQuantities: (clearStockQuantities: RequestParams.PutProductsParams["products"][number]["clearStockQuantities"]) => this
|
|
3208
3209
|
/** Dimensions and overall weight */
|
|
3209
|
-
productDimensions: (productDimensions:
|
|
3210
|
+
productDimensions: (productDimensions: RequestParams.PutProductsParams["products"][number]["productDimensions"]) => this
|
|
3210
3211
|
/** Responsible producer code */
|
|
3211
3212
|
responsibleProducerCode: (responsibleProducerCode: string) => this
|
|
3212
3213
|
/** Responsible person code */
|
|
3213
3214
|
responsiblePersonCode: (responsiblePersonCode: string) => this
|
|
3214
3215
|
/** Set various types of names or descriptions to the product */
|
|
3215
|
-
setText: (text: string, type?: "productName"|"productParamDescriptions"|"productLongDescription"|"productMetaTitle"|"productMetaDescription"|"productMetaKeyword"|"productAuctionName"|"productAuctionDescription"|"productAuctionAdditionalName"|"productNameInPriceComparer"
|
|
3216
|
+
setText: (text: string, type?: "productName"|"productParamDescriptions"|"productLongDescription"|"productMetaTitle"|"productMetaDescription"|"productMetaKeyword"|"productAuctionName"|"productAuctionDescription"|"productAuctionAdditionalName"|"productNameInPriceComparer", language?: string, shopId?: number|string) => this;
|
|
3216
3217
|
/** Set edit mode - disables adding new product */
|
|
3217
3218
|
editMode: () => this;
|
|
3218
3219
|
/** Set add mode - Api is allowed to create new products */
|
|
@@ -3227,56 +3228,56 @@ export interface PutProductsRequest extends AppendableGateway<PutProductsRequest
|
|
|
3227
3228
|
pictures: (picturesArray: string|string[]) => this;
|
|
3228
3229
|
}
|
|
3229
3230
|
|
|
3230
|
-
export interface SearchProductsRequest extends PagableGateway<SearchProductsRequest,SearchProductsResponse> {
|
|
3231
|
-
dispatchSettings: (value:
|
|
3231
|
+
export interface SearchProductsRequest extends PagableGateway<SearchProductsRequest, SearchProductsResponse, RequestParams.SearchProductsParams> {
|
|
3232
|
+
dispatchSettings: (value: RequestParams.SearchProductsParams["dispatchSettings"]) => this;
|
|
3232
3233
|
/** Element determines which products should be returned by the gate. Undeleted products are returned by default. Available values: "active" - undeleted products, "deleted" - deleted products. "in_trash" - products in the trash. */
|
|
3233
|
-
returnProducts: (value:
|
|
3234
|
+
returnProducts: (value: "active" | "deleted" | "in_trash") => this;
|
|
3234
3235
|
/** Elements to be returned by the endpoint. By default all elements are returned Available values: * lang_data * adding_time, * deleted, * code, * note, * taxcode, * inwrapper, * sellby_retail, * sellby_wholesale, * producer_id, * producer_name, * iaiCategoryId, * iaiCategoryName, * iaiCategoryPath, * category_id, * category_name, * size_group_id, * modification_time, * currency, * currency_shop, * bestseller, * new_product, * retail_price, * wholesale_price, * minimal_price, * automatic_calculation_price, * pos_price, * strikethrough_retail_price, * strikethrough_wholesale_price, * last_purchase_price, * purchase_price_net_average, * purchase_price_net_last, * purchase_price_gross_average, * purchase_price_gross_last, * vat, * vat_free, * rebate, * hotspots_zones, * profit_points, * points, * weight, * export_to_pricecomparers, * export_to_amazon_marketplace, * enable_in_pos, * complex_notes, * available_profile, * traits, * parameters, * version_data, * advance, * promotion, * discount, * distinguished, * special, * visible, * persistent, * priority, * shops_mask, * icon, * icon_for_auctions, * icon_for_group, * pictures, * unit, * warranty, * series, * products_associated, * shops, * quantities, * sizes_attributes, * shops_attributes, * auction_prices, * price_comparers_prices, * deliverer, * sizes, * size_group_name, * pictures_count, * product_type, * price_changed_time, * quantity_changed_time, * deliverer_name, * available_profile_name, * availability_management_type, * sum_in_basket, * menu, * auction_settings, * bundle, * sizeschart_id, * sizeschart_name, * serialnumbers, * producer_codes_standard, * javaScriptInTheItemCard, * productAuctionDescriptionsData, * priceFormula, * productIndividualDescriptionsData, * productIndividualUrlsData, * productServicesDescriptionsData, * cnTaricCode, * productIsGratis, * dimensions, * responsibleProducerCode, * responsiblePersonCode */
|
|
3235
3236
|
returnElements: (value: string|string[]) => this;
|
|
3236
3237
|
/** Product availability. Available values: "y" - available, "n" - unavailable. */
|
|
3237
|
-
productIsAvailable: (value:
|
|
3238
|
+
productIsAvailable: (value: "y" | "n") => this;
|
|
3238
3239
|
/** Product visibility in store Available values: "y" - Visible, "n" - Invisible. */
|
|
3239
|
-
productIsVisible: (value:
|
|
3240
|
+
productIsVisible: (value: "y" | "n") => this;
|
|
3240
3241
|
/** Product group ID */
|
|
3241
3242
|
productVersionId: (value: number|string) => this;
|
|
3242
3243
|
/** Promoted product. Available values: "y" - promoted, "n" - not promoted. */
|
|
3243
|
-
productInPromotion: (value:
|
|
3244
|
+
productInPromotion: (value: "y" | "n") => this;
|
|
3244
3245
|
/** Product on sale. Available values: "y" - on sale, "n" - not on sale. */
|
|
3245
|
-
productInDiscount: (value:
|
|
3246
|
+
productInDiscount: (value: "y" | "n") => this;
|
|
3246
3247
|
/** Distinguished product. Available values: "y" - distinguished, "n" - not distinguished. */
|
|
3247
|
-
productInDistinguished: (value:
|
|
3248
|
+
productInDistinguished: (value: "y" | "n") => this;
|
|
3248
3249
|
/** Special product. Available values: "y" - #!specjalny!#, "n" - not special. */
|
|
3249
|
-
productInSpecial: (value:
|
|
3250
|
+
productInSpecial: (value: "y" | "n") => this;
|
|
3250
3251
|
/** Product available for points. Available values: "y" - Available for points, "n" - Unavailable for points. */
|
|
3251
|
-
productInForPointsSelling: (value:
|
|
3252
|
+
productInForPointsSelling: (value: "y" | "n") => this;
|
|
3252
3253
|
/** Observed product. Available values: "Y" - observed, "n" - not observed. */
|
|
3253
|
-
productIsObservedByClients: (value:
|
|
3254
|
+
productIsObservedByClients: (value: "Y" | "n") => this;
|
|
3254
3255
|
/** Element determines if default product (with 0 ID, contains settings of newly added products) should be omitted Available values: "y" - omits default product, "n" - allows to download default product. */
|
|
3255
|
-
skipDefaultProduct: (value:
|
|
3256
|
+
skipDefaultProduct: (value: "y" | "n") => this;
|
|
3256
3257
|
/** The item specifies whether promotional prices are to be shown in price nodes. Available values: "y" - show promotional prices, "n" - do not show promotional prices. (default value) */
|
|
3257
|
-
showPromotionsPrices: (value:
|
|
3258
|
+
showPromotionsPrices: (value: "y" | "n") => this;
|
|
3258
3259
|
/** List of categories in which sought products are present. */
|
|
3259
|
-
categories: (value:
|
|
3260
|
+
categories: (value: RequestParams.SearchProductsParams["categories"]) => this;
|
|
3260
3261
|
/** List of manufacturers assigned to sought products. */
|
|
3261
|
-
producers: (value:
|
|
3262
|
+
producers: (value: RequestParams.SearchProductsParams["producers"]) => this;
|
|
3262
3263
|
/** List of sought products. This parameter can be used, when there have been no other parameter entered productIndexes. */
|
|
3263
|
-
productParams: (value:
|
|
3264
|
+
productParams: (value: RequestParams.SearchProductsParams["productParams"]) => this;
|
|
3264
3265
|
/** List of sought products by indexes. */
|
|
3265
|
-
productIndexes: (value:
|
|
3266
|
+
productIndexes: (value: RequestParams.SearchProductsParams["productIndexes"]) => this;
|
|
3266
3267
|
/** Data of stores product is assigned to. */
|
|
3267
|
-
productShops: (value:
|
|
3268
|
+
productShops: (value: RequestParams.SearchProductsParams["productShops"]) => this;
|
|
3268
3269
|
/** List of special offers, sought products are assigned to. */
|
|
3269
3270
|
productPromotionsIds: (value: number|string|number[]|string[]) => this;
|
|
3270
3271
|
/** Settings concerning narrowing list of products found by date. */
|
|
3271
|
-
productDate: (value:
|
|
3272
|
+
productDate: (value: RequestParams.SearchProductsParams["productDate"]) => this;
|
|
3272
3273
|
/** Parameters */
|
|
3273
|
-
productParametersParams: (value:
|
|
3274
|
+
productParametersParams: (value: RequestParams.SearchProductsParams["productParametersParams"]) => this;
|
|
3274
3275
|
/** Series, sought products are assigned to. */
|
|
3275
|
-
productSeriesParams: (value:
|
|
3276
|
+
productSeriesParams: (value: RequestParams.SearchProductsParams["productSeriesParams"]) => this;
|
|
3276
3277
|
/** List of units of measure assigned to sought products. */
|
|
3277
|
-
productUnits: (value:
|
|
3278
|
+
productUnits: (value: RequestParams.SearchProductsParams["productUnits"]) => this;
|
|
3278
3279
|
/** Narrowing list of products by set warranties. */
|
|
3279
|
-
productWarranties: (value:
|
|
3280
|
+
productWarranties: (value: RequestParams.SearchProductsParams["productWarranties"]) => this;
|
|
3280
3281
|
/** Suppliers, sought products are assigned to. */
|
|
3281
3282
|
deliverersIds: (value: number|string|number[]|string[]) => this;
|
|
3282
3283
|
/** Product contains text (searches in short and long description). */
|
|
@@ -3284,15 +3285,15 @@ export interface SearchProductsRequest extends PagableGateway<SearchProductsRequ
|
|
|
3284
3285
|
/** Product code or it's part (based on producer's code, external product system code and code that is visible on a product card). Search is accesible only with available products. */
|
|
3285
3286
|
containsCodePart: (value: string) => this;
|
|
3286
3287
|
/** Product availability in stocks */
|
|
3287
|
-
productAvailableInStocks: (value:
|
|
3288
|
+
productAvailableInStocks: (value: RequestParams.SearchProductsParams["productAvailableInStocks"]) => this;
|
|
3288
3289
|
/** Product availability on auctions */
|
|
3289
|
-
productAvailableInAuctions: (value:
|
|
3290
|
+
productAvailableInAuctions: (value: RequestParams.SearchProductsParams["productAvailableInAuctions"]) => this;
|
|
3290
3291
|
/** Page with results number. Numeration starts from 0 */
|
|
3291
3292
|
resultsPage: (value: number|string) => this;
|
|
3292
3293
|
/** Number of results on page. Value from 1 to 100 */
|
|
3293
3294
|
resultsLimit: (value: number|string) => this;
|
|
3294
3295
|
/** Possibility of sorting returned list */
|
|
3295
|
-
ordersBy: (value:
|
|
3296
|
+
ordersBy: (value: RequestParams.SearchProductsParams["ordersBy"]) => this;
|
|
3296
3297
|
/** Language ID that allows to search and return data in chosen language. This parameter is optional. If it's lacking, she search process unfolds in all available languages. */
|
|
3297
3298
|
productSearchingLangId: (value: string) => this;
|
|
3298
3299
|
/** Currency ID allowing to search and browse products in given currency. This parameter is optional, when it's lacking, the search process unfolds in all available currencies. */
|
|
@@ -3302,45 +3303,45 @@ export interface SearchProductsRequest extends PagableGateway<SearchProductsRequ
|
|
|
3302
3303
|
/** Annotation contains text. */
|
|
3303
3304
|
productHasNote: (value: string) => this;
|
|
3304
3305
|
/** Product visibility in export to price comparison and marketplaces. Available values: "y" - Visible, "selected" - Selected, "assign_selected" - Enable the visibility of the product in the export to price comparison sites passed in the priceComparisonSites node. Price comparison sites previously assigned to the commodity will be retained, "unassign_selected" - Disable product visibility in exports to price comparison sites passed in the priceComparisonSites node, "n" - invisible. */
|
|
3305
|
-
productInExportToPriceComparisonSites: (value:
|
|
3306
|
+
productInExportToPriceComparisonSites: (value: "y" | "selected" | "assign_selected" | "unassign_selected" | "n") => this;
|
|
3306
3307
|
/** Visibility of an item in an export to Amazon Marketplace. Available values: "y" - Visible, "selected" - Visible on selected regional services, "n" - invisible. */
|
|
3307
|
-
productInExportToAmazonMarketplace: (value:
|
|
3308
|
+
productInExportToAmazonMarketplace: (value: "y" | "selected" | "n") => this;
|
|
3308
3309
|
/** List of Amazon regional sites to which the product is exported (only in case of "selected" option) */
|
|
3309
3310
|
selectedAmazonMarketplacesList: (value: string|string[]) => this;
|
|
3310
3311
|
/** Product is bestseller. Available values: "n" - no, "y" - yes. */
|
|
3311
|
-
productInBestseller: (value:
|
|
3312
|
+
productInBestseller: (value: "n" | "y") => this;
|
|
3312
3313
|
/** Product is new. Available values: "y" - is new, "n" - is not new. */
|
|
3313
|
-
productInNew: (value:
|
|
3314
|
+
productInNew: (value: "y" | "n") => this;
|
|
3314
3315
|
/** Shops */
|
|
3315
|
-
searchByShops: (value:
|
|
3316
|
+
searchByShops: (value: RequestParams.SearchProductsParams["searchByShops"]) => this;
|
|
3316
3317
|
/** Price range for sought products. */
|
|
3317
|
-
productSearchPriceRange: (value:
|
|
3318
|
+
productSearchPriceRange: (value: RequestParams.SearchProductsParams["productSearchPriceRange"]) => this;
|
|
3318
3319
|
/** VAT value for sought products */
|
|
3319
3320
|
productVatRates: (value: Array<Number>) => this;
|
|
3320
3321
|
/** Is product VAT-free Allowed values "y" - yes, "n" - no. */
|
|
3321
3322
|
productIsVatFree: (value: string) => this;
|
|
3322
3323
|
/** Product has defined wholesale price. Available values: "y" - has wholesale price, "n" - does not have wholesale price. */
|
|
3323
|
-
productHasWholesalePrice: (value:
|
|
3324
|
+
productHasWholesalePrice: (value: "y" | "n") => this;
|
|
3324
3325
|
/** Product visible even though out of stock Available values: "y" - visible even though out of stock, "n" - not visible when out of stock. */
|
|
3325
|
-
productInPersistent: (value:
|
|
3326
|
+
productInPersistent: (value: "y" | "n") => this;
|
|
3326
3327
|
/** Settings of products returned with variants All products with variants are returned by default Available values: version_all - returns all variants, version_main - returns only main variant. */
|
|
3327
3328
|
returnProductsVersions: (value: string) => this;
|
|
3328
3329
|
/** Do You wish to sum up the products in the basket as a one order? Available values: "y" - yes, "n" - no. */
|
|
3329
|
-
productInSumInBasket: (value:
|
|
3330
|
+
productInSumInBasket: (value: "y" | "n") => this;
|
|
3330
3331
|
/** Product type. Allowed values: "product_item" - Goods, "product_packaging" - packaging, "product_bundle" - set. "product_collection" - collection. "product_service" - service. "product_virtual" - virtual product. "product_configurable" - configurable product. */
|
|
3331
|
-
productType: (value:
|
|
3332
|
+
productType: (value: RequestParams.SearchProductsParams["productType"]) => this;
|
|
3332
3333
|
/** An array of menu elements */
|
|
3333
|
-
productMenuItems: (value:
|
|
3334
|
+
productMenuItems: (value: RequestParams.SearchProductsParams["productMenuItems"]) => this;
|
|
3334
3335
|
/** Warehouse location ID */
|
|
3335
3336
|
productLocationId: (value: number|string) => this;
|
|
3336
3337
|
/** Warehouse location full path Use a backslash (\) as a separator, for example: M1\Section name\Location name If location_id parameter is provided, the full warehouse location path will not be taken into account */
|
|
3337
3338
|
productLocationTextId: (value: string) => this;
|
|
3338
3339
|
/** Return all size attributes regardless of whether product prices are the same as the base price or if they differ from it. Available values: 1 - all size attributes will be returned; 0 - only attributes of those sizes, where the prices will be different from the base price (default value) will be returned. */
|
|
3339
|
-
alwaysReturnProductShopSizesAttributes: (value:
|
|
3340
|
+
alwaysReturnProductShopSizesAttributes: (value: boolean) => this;
|
|
3340
3341
|
/** Returns reservation information regardless of inventory levels */
|
|
3341
|
-
returnEmptyStocksWithReservation: (value:
|
|
3342
|
+
returnEmptyStocksWithReservation: (value: boolean) => this;
|
|
3342
3343
|
/** Data for operations on individual photos */
|
|
3343
|
-
picturesData: (value:
|
|
3344
|
+
picturesData: (value: RequestParams.SearchProductsParams["picturesData"]) => this;
|
|
3344
3345
|
/** Responsible producer code */
|
|
3345
3346
|
responsibleProducerCode: (value: string) => this;
|
|
3346
3347
|
/** Responsible person code */
|
|
@@ -3504,7 +3505,7 @@ export interface PutProductsSeriesFilterRequest extends AppendableGateway<PutPro
|
|
|
3504
3505
|
filterDefaultEnabled: (filterDefaultEnabled: 'y'|'n') => this
|
|
3505
3506
|
}
|
|
3506
3507
|
|
|
3507
|
-
export interface GetProductsSeriesRequest extends PagableGateway<GetProductsSeriesRequest,GetProductsSeriesResponse> {
|
|
3508
|
+
export interface GetProductsSeriesRequest extends PagableGateway<GetProductsSeriesRequest, GetProductsSeriesResponse> {
|
|
3508
3509
|
/** With "y" value it returns the last series modification date in YYYY-MM-DD HH:MM:SS format. */
|
|
3509
3510
|
return_last_changed_time: (value: string) => this;
|
|
3510
3511
|
/** IDs */
|
|
@@ -3601,7 +3602,7 @@ export interface PutProductsStocksRequest extends AppendableGateway<PutProductsS
|
|
|
3601
3602
|
error: (error: JSObject) => this
|
|
3602
3603
|
}
|
|
3603
3604
|
|
|
3604
|
-
export interface GetProductsStrikethroughPricesRequest extends Gateway {
|
|
3605
|
+
export interface GetProductsStrikethroughPricesRequest extends Gateway<GetProductsStrikethroughPricesResponse> {
|
|
3605
3606
|
identType: (value: 'id'|'index'|'codeExtern'|'codeProducer') => this;
|
|
3606
3607
|
/** Products list. */
|
|
3607
3608
|
products: (value: string|string[]) => this;
|
|
@@ -3621,13 +3622,13 @@ export interface PutProductsStrikethroughPricesRequest extends AppendableGateway
|
|
|
3621
3622
|
/** Strikethrough price settings for the page. */
|
|
3622
3623
|
shops: (shops: Array<JSObject>) => this
|
|
3623
3624
|
/** Set product identifiers */
|
|
3624
|
-
productId: (productId: number|string, type?: 'id'|'index'|'codeExtern'|'codeProducer'
|
|
3625
|
+
productId: (productId: number|string, type?: 'id'|'index'|'codeExtern'|'codeProducer') => this;
|
|
3625
3626
|
/** Set precise price */
|
|
3626
|
-
setPrice: (price: number, wholesale?: boolean
|
|
3627
|
+
setPrice: (price: number, wholesale?: boolean) => this;
|
|
3627
3628
|
/** Set price relative to current price */
|
|
3628
|
-
addPrice: (value: number, wholesale?: boolean
|
|
3629
|
+
addPrice: (value: number, wholesale?: boolean, base?: 'price' | 'price_minimal' | 'price_pos' | 'price_srp' | 'price_crossed') => this;
|
|
3629
3630
|
/** Set price relative to current price by percent */
|
|
3630
|
-
addPricePercent: (value: number, wholesale?: boolean
|
|
3631
|
+
addPricePercent: (value: number, wholesale?: boolean, base?: 'price' | 'price_minimal' | 'price_pos' | 'price_srp' | 'price_crossed') => this;
|
|
3631
3632
|
}
|
|
3632
3633
|
|
|
3633
3634
|
export interface PutProductsSupplierCodeRequest extends AppendableGateway<PutProductsSupplierCodeRequest> {
|
|
@@ -3671,7 +3672,7 @@ export interface PutProductsSynchronizationFinishUploadRequest extends Gateway {
|
|
|
3671
3672
|
/** Total number of files in the parcel. */
|
|
3672
3673
|
filesInPackage: (value: number|string) => this;
|
|
3673
3674
|
/** Whether to verify the package by sparsifying files and preparing requests. It may take a few minutes to answer. */
|
|
3674
|
-
verifyFiles: (value:
|
|
3675
|
+
verifyFiles: (value: boolean) => this;
|
|
3675
3676
|
}
|
|
3676
3677
|
|
|
3677
3678
|
export interface PostRefundsAddAutomaticRefundRequest extends Gateway {
|
|
@@ -3685,7 +3686,7 @@ export interface PostRefundsAddAutomaticRefundForOrderRequest extends Gateway {
|
|
|
3685
3686
|
/** Source ID. */
|
|
3686
3687
|
sourceId: (value: number|string) => this;
|
|
3687
3688
|
/** Amount. */
|
|
3688
|
-
refundValue: (value:
|
|
3689
|
+
refundValue: (value: number) => this;
|
|
3689
3690
|
/** Payment ID. */
|
|
3690
3691
|
paymentId: (value: number|string) => this;
|
|
3691
3692
|
/** Payment currency. */
|
|
@@ -3698,7 +3699,7 @@ export interface PostRefundsAddManualRefundRequest extends Gateway {
|
|
|
3698
3699
|
/** Source ID. */
|
|
3699
3700
|
sourceId: (value: number|string) => this;
|
|
3700
3701
|
/** Amount. */
|
|
3701
|
-
refundValue: (value:
|
|
3702
|
+
refundValue: (value: number) => this;
|
|
3702
3703
|
/** Payment currency. */
|
|
3703
3704
|
refundCurrency: (value: string) => this;
|
|
3704
3705
|
refundDetails: (value: JSObject) => this;
|
|
@@ -3755,12 +3756,12 @@ export interface PutRefundsUpdateRefundRequest extends Gateway {
|
|
|
3755
3756
|
/** Payment ID. */
|
|
3756
3757
|
paymentId: (value: string) => this;
|
|
3757
3758
|
/** Amount. */
|
|
3758
|
-
refundValue: (value:
|
|
3759
|
+
refundValue: (value: number) => this;
|
|
3759
3760
|
/** Payment currency. */
|
|
3760
3761
|
refundCurrency: (value: string) => this;
|
|
3761
3762
|
}
|
|
3762
3763
|
|
|
3763
|
-
export interface GetResponsibilityEntitiesRequest extends PagableGateway<GetResponsibilityEntitiesRequest,GetResponsibilityEntitiesResponse> {
|
|
3764
|
+
export interface GetResponsibilityEntitiesRequest extends PagableGateway<GetResponsibilityEntitiesRequest, GetResponsibilityEntitiesResponse> {
|
|
3764
3765
|
/** List of codes */
|
|
3765
3766
|
code: (value: string|string[]) => this;
|
|
3766
3767
|
/** Type of entity */
|
|
@@ -3771,8 +3772,8 @@ export interface GetResponsibilityEntitiesRequest extends PagableGateway<GetResp
|
|
|
3771
3772
|
resultsLimit: (value: number|string) => this;
|
|
3772
3773
|
}
|
|
3773
3774
|
|
|
3774
|
-
export interface PostResponsibilityEntitiesRequest extends AppendableGateway<PostResponsibilityEntitiesRequest> {
|
|
3775
|
-
entities: (value:
|
|
3775
|
+
export interface PostResponsibilityEntitiesRequest extends AppendableGateway<PostResponsibilityEntitiesRequest, PostResponsibilityEntitiesResponse, RequestParams.PostResponsibilityEntitiesParams> {
|
|
3776
|
+
entities: (value: RequestParams.PostResponsibilityEntitiesParams["entities"]) => this;
|
|
3776
3777
|
/** Type of entity */
|
|
3777
3778
|
type: (value: 'producer'|'person') => this;
|
|
3778
3779
|
/** Identificator of the entity. */
|
|
@@ -3842,7 +3843,7 @@ export interface DeleteResponsibilityEntitiesRequest extends Gateway {
|
|
|
3842
3843
|
type: (value: string) => this;
|
|
3843
3844
|
}
|
|
3844
3845
|
|
|
3845
|
-
export interface GetReturnsRequest extends PagableGateway<GetReturnsRequest,GetReturnsResponse> {
|
|
3846
|
+
export interface GetReturnsRequest extends PagableGateway<GetReturnsRequest, GetReturnsResponse> {
|
|
3846
3847
|
/** Search by the order serial number to which a return was added. */
|
|
3847
3848
|
order_sn: (value: number|string) => this;
|
|
3848
3849
|
/** Search by return ID. */
|
|
@@ -3862,23 +3863,23 @@ export interface GetReturnsRequest extends PagableGateway<GetReturnsRequest,GetR
|
|
|
3862
3863
|
/** Search by ID of a stock to which a return is sent. */
|
|
3863
3864
|
stock_id: (value: number|string) => this;
|
|
3864
3865
|
/** Return a set as its constituent products */
|
|
3865
|
-
bundleAsProducts: (value:
|
|
3866
|
+
bundleAsProducts: (value: boolean) => this;
|
|
3866
3867
|
/** Define range of dates and their type */
|
|
3867
3868
|
dates: (dateFrom: DateLike, dateTo: DateLike, type: "date_add"|"date_end") => this;
|
|
3868
3869
|
}
|
|
3869
3870
|
|
|
3870
|
-
export interface PostReturnsRequest extends AppendableGateway<PostReturnsRequest> {
|
|
3871
|
+
export interface PostReturnsRequest extends AppendableGateway<PostReturnsRequest, PostReturnsResponse, RequestParams.PostReturnsParams> {
|
|
3871
3872
|
/** Order serial number */
|
|
3872
3873
|
order_sn: (value: number|string) => this;
|
|
3873
3874
|
stock_id: (value: number|string) => this;
|
|
3874
3875
|
/** Products list. */
|
|
3875
|
-
products: (value:
|
|
3876
|
+
products: (value: RequestParams.PostReturnsParams["products"]) => this;
|
|
3876
3877
|
status: (value: number|string) => this;
|
|
3877
|
-
client_received: (value:
|
|
3878
|
-
change_status: (value:
|
|
3878
|
+
client_received: (value: boolean) => this;
|
|
3879
|
+
change_status: (value: boolean) => this;
|
|
3879
3880
|
courier_id: (value: number|string) => this;
|
|
3880
3881
|
return_operator: (value: string) => this;
|
|
3881
|
-
tryCorrectInvoice: (value:
|
|
3882
|
+
tryCorrectInvoice: (value: boolean) => this;
|
|
3882
3883
|
include_shipping_cost: (value: string) => this;
|
|
3883
3884
|
additional_payment_cost: (value: string) => this;
|
|
3884
3885
|
emptyReturn: (value: 'n'|'y') => this;
|
|
@@ -3896,16 +3897,16 @@ export interface PostReturnsRequest extends AppendableGateway<PostReturnsRequest
|
|
|
3896
3897
|
productOrderAdditional: (productOrderAdditional: string) => this
|
|
3897
3898
|
}
|
|
3898
3899
|
|
|
3899
|
-
export interface PutReturnsRequest extends AppendableGateway<PutReturnsRequest> {
|
|
3900
|
-
returns: (value:
|
|
3900
|
+
export interface PutReturnsRequest extends AppendableGateway<PutReturnsRequest, PutReturnsResponse, RequestParams.PutReturnsParams> {
|
|
3901
|
+
returns: (value: RequestParams.PutReturnsParams["returns"]) => this;
|
|
3901
3902
|
/** */
|
|
3902
3903
|
id: (id: number|string) => this
|
|
3903
3904
|
/** */
|
|
3904
3905
|
status: (status: number|string) => this
|
|
3905
3906
|
/** Flag informing on order registration or completion in external program through API. Allowed values. "none" - order was not registered in external program, "registered" - order was registered in external program, "realized" - order was completed in external program, "registered_pos" - order was registered in external program, "realized_pos" - order was completed in external program. */
|
|
3906
|
-
apiFlag: (apiFlag:
|
|
3907
|
+
apiFlag: (apiFlag: RequestParams.PutReturnsParams["returns"][number]["apiFlag"]) => this
|
|
3907
3908
|
/** Products list. */
|
|
3908
|
-
products: (products:
|
|
3909
|
+
products: (products: RequestParams.PutReturnsParams["returns"][number]["products"]) => this
|
|
3909
3910
|
/** */
|
|
3910
3911
|
userNote: (userNote: string) => this
|
|
3911
3912
|
/** Notes from customer. */
|
|
@@ -3929,7 +3930,7 @@ export interface PutReturnsSerialNumberRequest extends AppendableGateway<PutRetu
|
|
|
3929
3930
|
|
|
3930
3931
|
export interface GetReturnsStatusesRequest extends Gateway {}
|
|
3931
3932
|
|
|
3932
|
-
export interface GetRmaRequest extends PagableGateway<GetRmaRequest,GetRmaResponse> {
|
|
3933
|
+
export interface GetRmaRequest extends PagableGateway<GetRmaRequest, GetRmaResponse> {
|
|
3933
3934
|
rmaIds: (value: number|string|number[]|string[]) => this;
|
|
3934
3935
|
/** Stock ID */
|
|
3935
3936
|
stockId: (value: number|string) => this;
|
|
@@ -3955,15 +3956,15 @@ export interface GetRmaRequest extends PagableGateway<GetRmaRequest,GetRmaRespon
|
|
|
3955
3956
|
ended: (dateFrom: DateLike, dateTo: DateLike) => this;
|
|
3956
3957
|
}
|
|
3957
3958
|
|
|
3958
|
-
export interface PutRmaRequest extends AppendableGateway<PutRmaRequest> {
|
|
3959
|
+
export interface PutRmaRequest extends AppendableGateway<PutRmaRequest, PutRmaResponse, RequestParams.PutRmaParams> {
|
|
3959
3960
|
/** Complaints. */
|
|
3960
|
-
rmas: (value:
|
|
3961
|
+
rmas: (value: RequestParams.PutRmaParams["rmas"]) => this;
|
|
3961
3962
|
/** Complaint id. */
|
|
3962
3963
|
rmaId: (rmaId: number|string) => this
|
|
3963
3964
|
/** Claim status. Available values: 15 - Complaint not confirmed by the shop service, 17 - The complaint has been cancelled, 18 - Complaint canceled by the customer, 14 - Complaint didn't arrive, 20 - Complaint not handled, 22 - Complaint rejected - no fault was found, 23 - Complaint rejected - the warranty period has expired, 24 - Complaint rejected - defect caused by improper use, 19 - Complaint confirmed, 28 - Complaint is being considered - repair completed, 5 - Complaint is being considered - Product sent to the producer , 4 - Complaint is being considered - Product was sent for testing, 6 - Complaint is being considered - Repair in progress, 29 - Complaint is being considered - the complaint requires additional information from the customer, 7 - Complaint adjusted negatively - no fault was found, 9 - Complaint adjusted negatively - the warranty period has expired, 30 - Complaint adjusted negatively - return shipment sent to the customer, 8 - Complaint adjusted negatively - defect caused by improper use, 25 - Complaint handled positively - return shipment sent to the customer, 12 - Complaint handled positively - replacement for a new product, 13 - Complaint handled positively - replacement for a different product, 26 - Complaint handled positively - a new item was shipped without waiting for the original one, 27 - Complaint handled positively - the recipient's data change on the sales document, 10 - Complaint handled positively - Refund - payment processing, 11 - Complaint handled positively - repair completed - payout made, 31 - Complaint handled positively - Awaiting correction invoice confirmation, 34 - Complaint handled positively - Refund - preparing correction invoice */
|
|
3964
3965
|
rmaStatusId: (rmaStatusId: number|string) => this
|
|
3965
3966
|
/** Customer correspondence. */
|
|
3966
|
-
rmaChat: (rmaChat:
|
|
3967
|
+
rmaChat: (rmaChat: RequestParams.PutRmaParams["rmas"][number]["rmaChat"]) => this
|
|
3967
3968
|
}
|
|
3968
3969
|
|
|
3969
3970
|
export interface GetRmaStatusesRequest extends Gateway {}
|
|
@@ -3977,7 +3978,7 @@ export interface DeleteSizechartsRequest extends Gateway {
|
|
|
3977
3978
|
ids: (value: number|string|number[]|string[]) => this;
|
|
3978
3979
|
}
|
|
3979
3980
|
|
|
3980
|
-
export interface GetSizechartsRequest extends PagableGateway<GetSizechartsRequest,GetSizechartsResponse> {
|
|
3981
|
+
export interface GetSizechartsRequest extends PagableGateway<GetSizechartsRequest, GetSizechartsResponse> {
|
|
3981
3982
|
/** IDs */
|
|
3982
3983
|
ids: (value: number|string|number[]|string[]) => this;
|
|
3983
3984
|
/** Names of size charts */
|
|
@@ -4028,7 +4029,7 @@ export interface PutSizesRequest extends AppendableGateway<PutSizesRequest> {
|
|
|
4028
4029
|
lang_data: (lang_data: Array<JSObject>) => this
|
|
4029
4030
|
}
|
|
4030
4031
|
|
|
4031
|
-
export interface GetSnippetsCampaignRequest extends PagableGateway<GetSnippetsCampaignRequest> {
|
|
4032
|
+
export interface GetSnippetsCampaignRequest extends PagableGateway<GetSnippetsCampaignRequest, GetSnippetsCampaignResponse> {
|
|
4032
4033
|
/** List of shop identifiers */
|
|
4033
4034
|
shopId: (value: number|string|number[]|string[]) => this;
|
|
4034
4035
|
/** List of identifiers */
|
|
@@ -4082,7 +4083,7 @@ export interface DeleteSnippetsCampaignRequest extends Gateway {
|
|
|
4082
4083
|
id: (value: number|string|number[]|string[]) => this;
|
|
4083
4084
|
}
|
|
4084
4085
|
|
|
4085
|
-
export interface GetSnippetsCookiesRequest extends PagableGateway<GetSnippetsCookiesRequest> {
|
|
4086
|
+
export interface GetSnippetsCookiesRequest extends PagableGateway<GetSnippetsCookiesRequest, GetSnippetsCookiesResponse> {
|
|
4086
4087
|
/** List of identifiers for specific cookies */
|
|
4087
4088
|
id: (value: number|string|number[]|string[]) => this;
|
|
4088
4089
|
/** Page with results number. Numeration starts from 0 */
|
|
@@ -4106,7 +4107,7 @@ export interface PostSnippetsCookiesRequest extends AppendableGateway<PostSnippe
|
|
|
4106
4107
|
/** Name of the cookie. */
|
|
4107
4108
|
name: (name: string) => this
|
|
4108
4109
|
/** Type of the cookie */
|
|
4109
|
-
type: (type: 'cookie'|'pixel'|'
|
|
4110
|
+
type: (type: 'cookie'|'pixel'|'localStorage') => this
|
|
4110
4111
|
/** Cookie lifetime mode */
|
|
4111
4112
|
lifeTimeType: (lifeTimeType: 'temporary'|'days'|'minutes') => this
|
|
4112
4113
|
/** Cookie lifetime */
|
|
@@ -4128,7 +4129,7 @@ export interface PutSnippetsCookiesRequest extends AppendableGateway<PutSnippets
|
|
|
4128
4129
|
/** Name of the cookie. */
|
|
4129
4130
|
name: (name: string) => this
|
|
4130
4131
|
/** Type of the cookie */
|
|
4131
|
-
type: (type: 'cookie'|'pixel'|'
|
|
4132
|
+
type: (type: 'cookie'|'pixel'|'localStorage') => this
|
|
4132
4133
|
/** Cookie lifetime mode */
|
|
4133
4134
|
lifeTimeType: (lifeTimeType: 'temporary'|'days'|'minutes') => this
|
|
4134
4135
|
/** Cookie lifetime */
|
|
@@ -4140,7 +4141,7 @@ export interface DeleteSnippetsCookiesRequest extends Gateway {
|
|
|
4140
4141
|
id: (value: number|string|number[]|string[]) => this;
|
|
4141
4142
|
}
|
|
4142
4143
|
|
|
4143
|
-
export interface GetSnippetsRequest extends PagableGateway<GetSnippetsRequest,GetSnippetsResponse> {
|
|
4144
|
+
export interface GetSnippetsRequest extends PagableGateway<GetSnippetsRequest, GetSnippetsResponse> {
|
|
4144
4145
|
/** List of campaign identifiers */
|
|
4145
4146
|
campaign: (value: number|string|number[]|string[]) => this;
|
|
4146
4147
|
/** List of identifiers */
|
|
@@ -4176,7 +4177,7 @@ export interface PostSnippetsRequest extends AppendableGateway<PostSnippetsReque
|
|
|
4176
4177
|
/** Content waiting time (timeout) in seconds. */
|
|
4177
4178
|
timeout: (timeout: number|string) => this
|
|
4178
4179
|
/** The place where the code snippet is loaded. */
|
|
4179
|
-
zone: (zone: 'head'|'
|
|
4180
|
+
zone: (zone: 'head'|'bodyBegin'|'bodyEnd') => this
|
|
4180
4181
|
/** The order in which the code snippet will be displayed. */
|
|
4181
4182
|
order: (order: number|string) => this
|
|
4182
4183
|
/** Snippet content for each language. */
|
|
@@ -4212,7 +4213,7 @@ export interface PutSnippetsRequest extends AppendableGateway<PutSnippetsRequest
|
|
|
4212
4213
|
/** Content waiting time (timeout) in seconds. */
|
|
4213
4214
|
timeout: (timeout: number|string) => this
|
|
4214
4215
|
/** The place where the code snippet is loaded. */
|
|
4215
|
-
zone: (zone: 'head'|'
|
|
4216
|
+
zone: (zone: 'head'|'bodyBegin'|'bodyEnd') => this
|
|
4216
4217
|
/** The order in which the code snippet will be displayed. */
|
|
4217
4218
|
order: (order: number|string) => this
|
|
4218
4219
|
/** Snippet content for each language. */
|
|
@@ -4243,14 +4244,14 @@ export interface PostSubscriptionsChangeDeliveryDatesRequest extends Gateway {
|
|
|
4243
4244
|
/** Settings that determinates if price should be updated automaticly */
|
|
4244
4245
|
upcomingDeliveryDate: (value: string) => this;
|
|
4245
4246
|
/** A setting that determines whether to also change the date of the next delivery. */
|
|
4246
|
-
changeNextDeliveryDate: (value:
|
|
4247
|
+
changeNextDeliveryDate: (value: boolean) => this;
|
|
4247
4248
|
}
|
|
4248
4249
|
|
|
4249
4250
|
export interface PostSubscriptionsChangePriceAutoUpdateRequest extends Gateway {
|
|
4250
4251
|
/** Subscription ids */
|
|
4251
4252
|
subscriptionIds: (value: number|string|number[]|string[]) => this;
|
|
4252
4253
|
/** Settings that determinates if price should be updated automaticly */
|
|
4253
|
-
autoPriceUpdate: (value:
|
|
4254
|
+
autoPriceUpdate: (value: boolean) => this;
|
|
4254
4255
|
}
|
|
4255
4256
|
|
|
4256
4257
|
export interface PostSubscriptionsChangeStatusRequest extends Gateway {
|
|
@@ -4259,9 +4260,9 @@ export interface PostSubscriptionsChangeStatusRequest extends Gateway {
|
|
|
4259
4260
|
/** Status to set */
|
|
4260
4261
|
subscriptionStatus: (value: 'active'|'hold'|'nonpayment'|'finished') => this;
|
|
4261
4262
|
/** Option allowing sending e-mail after status change */
|
|
4262
|
-
sendMailAfterStatusChange: (value:
|
|
4263
|
+
sendMailAfterStatusChange: (value: boolean) => this;
|
|
4263
4264
|
/** Optian allowing sending SMS after status change */
|
|
4264
|
-
sendSMSAfterStatusChange: (value:
|
|
4265
|
+
sendSMSAfterStatusChange: (value: boolean) => this;
|
|
4265
4266
|
}
|
|
4266
4267
|
|
|
4267
4268
|
export interface PostSubscriptionsDeleteProductRequest extends Gateway {
|
|
@@ -4359,7 +4360,7 @@ export interface PutSystemCurrenciesRequest extends AppendableGateway<PutSystemC
|
|
|
4359
4360
|
scale: (scale: number|string) => this
|
|
4360
4361
|
}
|
|
4361
4362
|
|
|
4362
|
-
export interface GetSystemProcessesAutomationRequest extends Gateway {
|
|
4363
|
+
export interface GetSystemProcessesAutomationRequest extends Gateway<GetSystemProcessesAutomationResponse> {
|
|
4363
4364
|
/** Shop Id */
|
|
4364
4365
|
shopId: (value: number|string) => this;
|
|
4365
4366
|
}
|
|
@@ -4409,7 +4410,7 @@ export interface PutVouchersBlockRequest extends AppendableGateway<PutVouchersBl
|
|
|
4409
4410
|
number: (number: string) => this
|
|
4410
4411
|
}
|
|
4411
4412
|
|
|
4412
|
-
export interface GetVouchersTypesRequest extends PagableGateway<GetVouchersTypesRequest> {
|
|
4413
|
+
export interface GetVouchersTypesRequest extends PagableGateway<GetVouchersTypesRequest, GetVouchersTypesResponse> {
|
|
4413
4414
|
/** Page with results number. Numeration starts from 0 */
|
|
4414
4415
|
resultsPage: (value: number|string) => this;
|
|
4415
4416
|
/** Number of results on page. Value from 1 to 100 */
|
|
@@ -4432,7 +4433,7 @@ export interface DeleteVouchersRequest extends AppendableGateway<DeleteVouchersR
|
|
|
4432
4433
|
number: (number: string) => this
|
|
4433
4434
|
}
|
|
4434
4435
|
|
|
4435
|
-
export interface GetVouchersRequest extends PagableGateway<GetVouchersRequest> {
|
|
4436
|
+
export interface GetVouchersRequest extends PagableGateway<GetVouchersRequest, GetVouchersResponse> {
|
|
4436
4437
|
vouchers: (value: Array<JSObject>) => this;
|
|
4437
4438
|
/** Discount code campaign ID */
|
|
4438
4439
|
voucherTypeId: (value: number|string) => this;
|
|
@@ -4445,9 +4446,9 @@ export interface GetVouchersRequest extends PagableGateway<GetVouchersRequest> {
|
|
|
4445
4446
|
/** Notes contain */
|
|
4446
4447
|
noteContain: (value: string) => this;
|
|
4447
4448
|
/** Value from */
|
|
4448
|
-
balanceFrom: (value:
|
|
4449
|
+
balanceFrom: (value: number) => this;
|
|
4449
4450
|
/** Value to */
|
|
4450
|
-
balanceTo: (value:
|
|
4451
|
+
balanceTo: (value: number) => this;
|
|
4451
4452
|
/** Expiration date from */
|
|
4452
4453
|
expirationDateFrom: (value: string) => this;
|
|
4453
4454
|
/** Expiration date to */
|
|
@@ -4534,7 +4535,7 @@ export interface DeleteWarrantiesRequest extends Gateway {
|
|
|
4534
4535
|
warranty_ids: (value: string|string[]) => this;
|
|
4535
4536
|
}
|
|
4536
4537
|
|
|
4537
|
-
export interface GetWarrantiesRequest extends PagableGateway<GetWarrantiesRequest,GetWarrantiesResponse> {
|
|
4538
|
+
export interface GetWarrantiesRequest extends PagableGateway<GetWarrantiesRequest, GetWarrantiesResponse> {
|
|
4538
4539
|
warranty_ids: (value: string|string[]) => this;
|
|
4539
4540
|
/** Number of results on page. */
|
|
4540
4541
|
results_limit: (value: number|string) => this;
|
|
@@ -4569,7 +4570,7 @@ export interface PutWarrantiesRequest extends AppendableGateway<PutWarrantiesReq
|
|
|
4569
4570
|
period: (period: number|string) => this
|
|
4570
4571
|
}
|
|
4571
4572
|
|
|
4572
|
-
export interface GetWmsLocationsRequest extends PagableGateway<GetWmsLocationsRequest,GetWmsLocationsResponse> {
|
|
4573
|
+
export interface GetWmsLocationsRequest extends PagableGateway<GetWmsLocationsRequest, GetWmsLocationsResponse> {
|
|
4573
4574
|
/** Warehouse location ID */
|
|
4574
4575
|
locationId: (value: number|string) => this;
|
|
4575
4576
|
/** Storage location code */
|
|
@@ -4601,7 +4602,7 @@ export interface DeleteWmsStocksdocumentsDocumentsRequest extends Gateway {
|
|
|
4601
4602
|
id: (value: number|string) => this;
|
|
4602
4603
|
}
|
|
4603
4604
|
|
|
4604
|
-
export interface GetWmsStocksdocumentsDocumentsRequest extends PagableGateway<GetWmsStocksdocumentsDocumentsRequest,GetWmsStocksdocumentsDocumentsResponse> {
|
|
4605
|
+
export interface GetWmsStocksdocumentsDocumentsRequest extends PagableGateway<GetWmsStocksdocumentsDocumentsRequest, GetWmsStocksdocumentsDocumentsResponse> {
|
|
4605
4606
|
/** Document type. */
|
|
4606
4607
|
stockDocumentType: (value: 'pz'|'pw'|'px'|'rx'|'rw'|'wz'|'mm'|'zw') => this;
|
|
4607
4608
|
/** Document status. */
|
|
@@ -4622,7 +4623,7 @@ export interface GetWmsStocksdocumentsDocumentsRequest extends PagableGateway<Ge
|
|
|
4622
4623
|
dates: (dateFrom: DateLike, dateTo: DateLike, type: "open"|"modify"|"close"|"stockOperation") => this;
|
|
4623
4624
|
}
|
|
4624
4625
|
|
|
4625
|
-
export interface PostWmsStocksdocumentsDocumentsRequest extends Gateway {
|
|
4626
|
+
export interface PostWmsStocksdocumentsDocumentsRequest extends Gateway<PostWmsStocksdocumentsDocumentsResponse, RequestParams.PostWmsStocksdocumentsDocumentsParams> {
|
|
4626
4627
|
type: (value: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => this;
|
|
4627
4628
|
/** Target warehouse ID. The list of available warehouses can be downloaded via the method <a href = "en/shop/api/?action=method&function=systemconfig&method=get">#get</a> in gateway <a href = "en/shop/api/?action=documentation&function=systemconfig">SystemConfig</a>. */
|
|
4628
4629
|
stockId: (value: number|string) => this;
|
|
@@ -4678,7 +4679,7 @@ export interface PutWmsStocksdocumentsDocumentsRequest extends Gateway {
|
|
|
4678
4679
|
/** Purchase price currency, e.g. PLN, USD, GBP */
|
|
4679
4680
|
currencyForPurchasePrice: (value: string) => this;
|
|
4680
4681
|
/** Currency exchange rate (Currency conversion) */
|
|
4681
|
-
currencyForPurchasePriceRate: (value:
|
|
4682
|
+
currencyForPurchasePriceRate: (value: number) => this;
|
|
4682
4683
|
/** Type of currency rate. Available values: "custom" - not typical, "currentDay" - the currency rate from the day of issuing a stock document, "customDay" - on a selected day, "previousDay" - the currency rate of a working day preceding the date of the stock document issue. */
|
|
4683
4684
|
currencyForPurchasePriceRateType: (value: 'custom'|'currentDay'|'customDay'|'previousDay') => this;
|
|
4684
4685
|
/** Currency rate of the day. Correct format is yyyy-mm-dd, e.g. 2007-12-31.. */
|
|
@@ -4722,7 +4723,7 @@ export interface DeleteWmsStocksdocumentsProductsRequest extends AppendableGatew
|
|
|
4722
4723
|
size: (size: string) => this
|
|
4723
4724
|
}
|
|
4724
4725
|
|
|
4725
|
-
export interface GetWmsStocksdocumentsProductsRequest extends PagableGateway<GetWmsStocksdocumentsProductsRequest,GetWmsStocksdocumentsProductsResponse> {
|
|
4726
|
+
export interface GetWmsStocksdocumentsProductsRequest extends PagableGateway<GetWmsStocksdocumentsProductsRequest, GetWmsStocksdocumentsProductsResponse> {
|
|
4726
4727
|
type: (value: 'pz'|'pw'|'px'|'rx'|'rw'|'mm'|'wz'|'zw') => this;
|
|
4727
4728
|
/** Document identifier. */
|
|
4728
4729
|
id: (value: number|string) => this;
|
|
@@ -4732,9 +4733,9 @@ export interface GetWmsStocksdocumentsProductsRequest extends PagableGateway<Get
|
|
|
4732
4733
|
results_limit: (value: number|string) => this;
|
|
4733
4734
|
}
|
|
4734
4735
|
|
|
4735
|
-
export interface PostWmsStocksdocumentsProductsRequest extends AppendableGateway<PostWmsStocksdocumentsProductsRequest> {
|
|
4736
|
+
export interface PostWmsStocksdocumentsProductsRequest extends AppendableGateway<PostWmsStocksdocumentsProductsRequest, PostWmsStocksdocumentsProductsResponse, RequestParams.PostWmsStocksdocumentsProductsParams> {
|
|
4736
4737
|
/** Products list. */
|
|
4737
|
-
products: (value:
|
|
4738
|
+
products: (value: RequestParams.PostWmsStocksdocumentsProductsParams["products"]) => this;
|
|
4738
4739
|
type: (value: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => this;
|
|
4739
4740
|
/** Document identifier. */
|
|
4740
4741
|
id: (value: number|string) => this;
|
|
@@ -4754,9 +4755,9 @@ export interface PostWmsStocksdocumentsProductsRequest extends AppendableGateway
|
|
|
4754
4755
|
locationTextId: (locationTextId: string) => this
|
|
4755
4756
|
}
|
|
4756
4757
|
|
|
4757
|
-
export interface PutWmsStocksdocumentsProductsRequest extends AppendableGateway<PutWmsStocksdocumentsProductsRequest> {
|
|
4758
|
+
export interface PutWmsStocksdocumentsProductsRequest extends AppendableGateway<PutWmsStocksdocumentsProductsRequest, PutWmsStocksdocumentsProductsResponse, RequestParams.PutWmsStocksdocumentsProductsParams> {
|
|
4758
4759
|
/** Products list. */
|
|
4759
|
-
products: (value:
|
|
4760
|
+
products: (value: RequestParams.PutWmsStocksdocumentsProductsParams["products"]) => this;
|
|
4760
4761
|
type: (value: 'pz'|'pw'|'px'|'rx'|'rw'|'mm') => this;
|
|
4761
4762
|
/** Document identifier. */
|
|
4762
4763
|
id: (value: number|string) => this;
|
|
@@ -4786,13 +4787,13 @@ export interface DeleteWmsSuppliersRequest extends Gateway {
|
|
|
4786
4787
|
ids: (value: number|string|number[]|string[]) => this;
|
|
4787
4788
|
}
|
|
4788
4789
|
|
|
4789
|
-
export interface GetWmsSuppliersRequest extends PagableGateway<GetWmsSuppliersRequest,GetWmsSuppliersResponse> {
|
|
4790
|
+
export interface GetWmsSuppliersRequest extends PagableGateway<GetWmsSuppliersRequest, GetWmsSuppliersResponse> {
|
|
4790
4791
|
/** Page with results number. Numeration starts from 0 */
|
|
4791
4792
|
resultsPage: (value: number|string) => this;
|
|
4792
4793
|
/** Number of results on page. Value from 1 to 100 */
|
|
4793
4794
|
resultsLimit: (value: number|string) => this;
|
|
4794
4795
|
/** Return quantity of products assigned to supplier */
|
|
4795
|
-
returnProductsCount: (value:
|
|
4796
|
+
returnProductsCount: (value: boolean) => this;
|
|
4796
4797
|
/** Names */
|
|
4797
4798
|
names: (value: string|string[]) => this;
|
|
4798
4799
|
/** IDs */
|
|
@@ -5179,4 +5180,4 @@ export interface Gateways {
|
|
|
5179
5180
|
|
|
5180
5181
|
declare const defaultExport: (url: string, apiKey: string, version?: number | string) => Gateways;
|
|
5181
5182
|
export default defaultExport;
|
|
5182
|
-
export { ENUMS }
|
|
5183
|
+
export { ENUMS, RequestParams }
|