idosell 0.3.20 → 0.4.1
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/dist/app.d.ts +4 -4
- package/dist/gateways.d.ts +161 -160
- package/dist/index.js +2 -2
- package/dist/methods/getEntries.js +1 -0
- package/dist/reqparams.d.ts +2260 -0
- package/dist/responses.d.ts +697 -2
- 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/dist/responses.d.ts
CHANGED
|
@@ -2039,7 +2039,7 @@ export type SearchPackagesResponse = {
|
|
|
2039
2039
|
};
|
|
2040
2040
|
|
|
2041
2041
|
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2042
|
-
export type
|
|
2042
|
+
export type SearchProductsCategoriesIdosellResponse = {
|
|
2043
2043
|
/** @description List of IdoSell Categories */
|
|
2044
2044
|
categoriesIdoSell: {
|
|
2045
2045
|
/** @description IdoSell Category ID */
|
|
@@ -4902,10 +4902,705 @@ export type GetOrdersStatusesResponse = {
|
|
|
4902
4902
|
/** @description Status identifier */
|
|
4903
4903
|
id: number;
|
|
4904
4904
|
/** @description Parent status identifier */
|
|
4905
|
-
parentId:
|
|
4905
|
+
parentId: number | null;
|
|
4906
4906
|
/** @example Packed by Employee#1 */
|
|
4907
4907
|
panelName: string;
|
|
4908
4908
|
}[];
|
|
4909
4909
|
};
|
|
4910
4910
|
|
|
4911
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
4912
|
+
export type GetPaymentsResponse = {
|
|
4913
|
+
/** @description Parameters concerning returned results */
|
|
4914
|
+
result: {
|
|
4915
|
+
/** @description Order serial number. */
|
|
4916
|
+
orderNumber: number;
|
|
4917
|
+
/** @description Payment number for order. */
|
|
4918
|
+
ordinalNumber: number;
|
|
4919
|
+
/** @description Amount of payment. */
|
|
4920
|
+
value: number;
|
|
4921
|
+
/** @description Order currency ID (currency list can be obtained through getShopsData gate). */
|
|
4922
|
+
currency: string;
|
|
4923
|
+
/** @description Registering date. */
|
|
4924
|
+
accountingDate: string;
|
|
4925
|
+
/** */
|
|
4926
|
+
status: "pending" | "processed" | "cancelled";
|
|
4927
|
+
/** @description Form of payment ID. */
|
|
4928
|
+
paymentFormId: number;
|
|
4929
|
+
/** @description Transaction ID in external service */
|
|
4930
|
+
externalPaymentId: string;
|
|
4931
|
+
/** @description The additional status of the payment or refund returned by the third-party service. For returns by IdoPay, possible values are: "waiting", "waiting for funds", "waiting for data", "processed", "confirmed", "rejected", "error". */
|
|
4932
|
+
externalPaymentStatus: string;
|
|
4933
|
+
/** @description Event log. */
|
|
4934
|
+
eventLog: {
|
|
4935
|
+
/** @description Event log. */
|
|
4936
|
+
eventLogList: {
|
|
4937
|
+
/** @description User login. */
|
|
4938
|
+
user: string;
|
|
4939
|
+
/** @description Error code. */
|
|
4940
|
+
eventCode: string;
|
|
4941
|
+
/** @description Date. */
|
|
4942
|
+
date: string;
|
|
4943
|
+
/** */
|
|
4944
|
+
level: "info" | "error" | "warn";
|
|
4945
|
+
/** @description Error description. */
|
|
4946
|
+
details: string;
|
|
4947
|
+
}[];
|
|
4948
|
+
};
|
|
4949
|
+
};
|
|
4950
|
+
};
|
|
4951
|
+
|
|
4952
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
4953
|
+
export type GetProductsStrikethroughPricesResponse = {
|
|
4954
|
+
/** @description Products list. */
|
|
4955
|
+
products: {
|
|
4956
|
+
[productId: string]: {
|
|
4957
|
+
/** @description Identifier type. */
|
|
4958
|
+
ident: {
|
|
4959
|
+
/** */
|
|
4960
|
+
type: "id" | "index" | "codeExtern" | "codeProducer";
|
|
4961
|
+
/** @description Value. */
|
|
4962
|
+
value: number;
|
|
4963
|
+
};
|
|
4964
|
+
/** @description Strikethrough gross retail price. */
|
|
4965
|
+
strikethrough_retail_price: number;
|
|
4966
|
+
/** @description Strikethrough gross wholesale price. */
|
|
4967
|
+
strikethrough_wholesale_price: number;
|
|
4968
|
+
shops: {
|
|
4969
|
+
[shop: string]: {
|
|
4970
|
+
/** @description Shop Id */
|
|
4971
|
+
shop_id: number;
|
|
4972
|
+
/** @description Strikethrough gross retail price. */
|
|
4973
|
+
strikethrough_retail_price: number;
|
|
4974
|
+
/** @description Strikethrough gross wholesale price. */
|
|
4975
|
+
strikethrough_wholesale_price: number;
|
|
4976
|
+
/** @description List of sizes */
|
|
4977
|
+
sizes: {
|
|
4978
|
+
[size: string]: {
|
|
4979
|
+
/** @description Identifier type. */
|
|
4980
|
+
ident: {
|
|
4981
|
+
/** */
|
|
4982
|
+
type: "id" | "index" | "codeExtern" | "codeProducer";
|
|
4983
|
+
/** @description Value. */
|
|
4984
|
+
value: string;
|
|
4985
|
+
};
|
|
4986
|
+
/** @description Strikethrough gross retail price. */
|
|
4987
|
+
strikethrough_retail_price: number;
|
|
4988
|
+
/** @description Strikethrough gross wholesale price. */
|
|
4989
|
+
strikethrough_wholesale_price: number
|
|
4990
|
+
} | []
|
|
4991
|
+
}
|
|
4992
|
+
} | []
|
|
4993
|
+
};
|
|
4994
|
+
/** @description Error information. */
|
|
4995
|
+
error?: FaultCodeString
|
|
4996
|
+
} | []
|
|
4997
|
+
};
|
|
4998
|
+
};
|
|
4999
|
+
|
|
5000
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
5001
|
+
export type GetSystemProcessesAutomationResponse = {
|
|
5002
|
+
/** @description Orders. */
|
|
5003
|
+
orders: {
|
|
5004
|
+
shops: {
|
|
5005
|
+
/** @description Shop Id */
|
|
5006
|
+
shopId: number;
|
|
5007
|
+
/** @description Allow the status to be changed to "Shipped" even if the order payments and stock levels do not match */
|
|
5008
|
+
alwaysAllowSentStatus: "y" | "n";
|
|
5009
|
+
}[];
|
|
5010
|
+
/** @description Order management restrictions */
|
|
5011
|
+
restrictions: {
|
|
5012
|
+
/** @description Block the ability of selecting a status, if there are products in the warehouse from which the order is being processed, with insufficient stock level. */
|
|
5013
|
+
blockIfIncorrectStockQuantities: {
|
|
5014
|
+
restrictedShops: {
|
|
5015
|
+
/** @description Shop Id */
|
|
5016
|
+
shopId: number;
|
|
5017
|
+
/** @description Block the ability of selecting a status "completed" if there are products in the warehouse from which the order is being processed, with insufficient stock level */
|
|
5018
|
+
finished: "y" | "n";
|
|
5019
|
+
}[];
|
|
5020
|
+
};
|
|
5021
|
+
};
|
|
5022
|
+
};
|
|
5023
|
+
};
|
|
5024
|
+
|
|
5025
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
5026
|
+
export type GetEntriesPagesToDisplayResponse = {
|
|
5027
|
+
/** @description Parameters concerning returned results */
|
|
5028
|
+
result: {
|
|
5029
|
+
/** @description List of pages on which the entry is to be published */
|
|
5030
|
+
pagesToDisplayOn: {
|
|
5031
|
+
/** @description Page ID */
|
|
5032
|
+
siteId: string;
|
|
5033
|
+
/** @description Store name */
|
|
5034
|
+
siteName: string;
|
|
5035
|
+
}[];
|
|
5036
|
+
};
|
|
5037
|
+
};
|
|
5038
|
+
|
|
5039
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
5040
|
+
export type GetEntriesResponse = {
|
|
5041
|
+
/** @description Parameters concerning returned results */
|
|
5042
|
+
result: {
|
|
5043
|
+
/** @description Blog entry content */
|
|
5044
|
+
entry: {
|
|
5045
|
+
/** @description Date of creating an entry */
|
|
5046
|
+
date: string;
|
|
5047
|
+
/** @description Entry visibility */
|
|
5048
|
+
visible: "y" | "n";
|
|
5049
|
+
/** @description Photo */
|
|
5050
|
+
picture: string;
|
|
5051
|
+
/** @description Name on the page */
|
|
5052
|
+
title: string;
|
|
5053
|
+
/** @description short description */
|
|
5054
|
+
shortDescription: string;
|
|
5055
|
+
/** @description Long description */
|
|
5056
|
+
longDescription: string;
|
|
5057
|
+
/** @description Blog post URL */
|
|
5058
|
+
blogUrl: string;
|
|
5059
|
+
/** @description News item URL */
|
|
5060
|
+
newsUrl: string;
|
|
5061
|
+
/** @description Products list. */
|
|
5062
|
+
products: {
|
|
5063
|
+
/** @description Merchandise identifier */
|
|
5064
|
+
productId: string;
|
|
5065
|
+
/** @description Product name. */
|
|
5066
|
+
productName: string;
|
|
5067
|
+
}[];
|
|
5068
|
+
/** @description List of pages on which the entry is to be published */
|
|
5069
|
+
visibleOnSitesList: {
|
|
5070
|
+
/** @description Page ID */
|
|
5071
|
+
siteId: string;
|
|
5072
|
+
/** @description Store name */
|
|
5073
|
+
siteName: string;
|
|
5074
|
+
}[];
|
|
5075
|
+
/** @description Type of title and shortcut linking: fullContentLink - link to the subpage with full content, givenUrlLink - link to the given URL, noLink - static element */
|
|
5076
|
+
titleLinkType: string;
|
|
5077
|
+
/** @description Provided URL (for link to specified URL option) */
|
|
5078
|
+
link: string;
|
|
5079
|
+
};
|
|
5080
|
+
};
|
|
5081
|
+
};
|
|
5082
|
+
|
|
5083
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
5084
|
+
export type GetCpaResponse = {
|
|
5085
|
+
results: {
|
|
5086
|
+
/** @description Id of the CPA program. */
|
|
5087
|
+
id: number | null;
|
|
5088
|
+
/** @description The CPA program name. */
|
|
5089
|
+
name: string;
|
|
5090
|
+
/** @description Whether the CPA program is active. */
|
|
5091
|
+
active: "y" | "n";
|
|
5092
|
+
/** @description CPA campaign id */
|
|
5093
|
+
campaign: number;
|
|
5094
|
+
/** @description CPA program page settings simple or advanced, depending on the mode. */
|
|
5095
|
+
pageSettings: (Omit<{
|
|
5096
|
+
/** @description Whether to display to all sites. */
|
|
5097
|
+
mode: "simple" | "advanced";
|
|
5098
|
+
}, "mode"> & {
|
|
5099
|
+
/** @description Whether to display to all sites. */
|
|
5100
|
+
mode: "simple";
|
|
5101
|
+
/** @description The place where the cpa code is loaded. (For "all" mode)
|
|
5102
|
+
|null} */
|
|
5103
|
+
zone: "head" | "bodyBegin" | "bodyEnd" | null;
|
|
5104
|
+
/** @description Snippet content for each language. (For "all" mode) */
|
|
5105
|
+
body: {
|
|
5106
|
+
/** @description Language code. */
|
|
5107
|
+
lang: string;
|
|
5108
|
+
/** @example Hello world */
|
|
5109
|
+
body: string;
|
|
5110
|
+
}[] | null;
|
|
5111
|
+
}) | (Omit<{
|
|
5112
|
+
/** @description Whether to display to all sites. */
|
|
5113
|
+
mode: "simple" | "advanced";
|
|
5114
|
+
}, "mode"> & {
|
|
5115
|
+
/** @description Whether to display to all sites. */
|
|
5116
|
+
mode: "advanced";
|
|
5117
|
+
/** @description Page setting for advance mode */
|
|
5118
|
+
pages: {
|
|
5119
|
+
/** @enum {string} */
|
|
5120
|
+
active: "y" | "n";
|
|
5121
|
+
/** @enum {string} */
|
|
5122
|
+
page: "home" | "basket" | "checkout_payment_delivery" | "checkout_confirmation" | "new_order_placement" | "order_details" | "navigation" | "product_details" | "search_results" | "after_order_place" | "mailing_subscribe" | "other_pages";
|
|
5123
|
+
/** @description The place where the cpa code is loaded. (For "all" mode) */
|
|
5124
|
+
zone: "head" | "bodyBegin" | "bodyEnd";
|
|
5125
|
+
body: {
|
|
5126
|
+
/** @description Language code. */
|
|
5127
|
+
lang: string;
|
|
5128
|
+
/** @example Hello world */
|
|
5129
|
+
body: string;
|
|
5130
|
+
}[];
|
|
5131
|
+
}[];
|
|
5132
|
+
});
|
|
5133
|
+
display: {
|
|
5134
|
+
/** @description Type of customers to whom to display the snippet */
|
|
5135
|
+
clientType: "all" | "unregistered" | "registered" | "retailer" | "wholesaler";
|
|
5136
|
+
/** @description Whether to display only for newsletter visitors. */
|
|
5137
|
+
newsletter: "y" | "n" | "all";
|
|
5138
|
+
/** @description Whether to display the code snippet only for customers who have placed an order */
|
|
5139
|
+
hasOrders: "y" | "n" | "all";
|
|
5140
|
+
/** @description Display only after entering rebate code */
|
|
5141
|
+
useRebateCode: "y" | "n" | "all";
|
|
5142
|
+
};
|
|
5143
|
+
/** @description Snippet entry source filter. */
|
|
5144
|
+
sources: {
|
|
5145
|
+
direct: {
|
|
5146
|
+
/** @description Whether source filter is active */
|
|
5147
|
+
active: "y" | "n";
|
|
5148
|
+
/** @description Id of service of given source */
|
|
5149
|
+
id: number | null;
|
|
5150
|
+
} | null;
|
|
5151
|
+
search: {
|
|
5152
|
+
/** @description Whether source filter is active */
|
|
5153
|
+
active: "y" | "n";
|
|
5154
|
+
/** @description Id of service of given source */
|
|
5155
|
+
id: number | null;
|
|
5156
|
+
} | null;
|
|
5157
|
+
advert: {
|
|
5158
|
+
/** @description Whether source filter is active */
|
|
5159
|
+
active: "y" | "n";
|
|
5160
|
+
/** @description Id of service of given source */
|
|
5161
|
+
id: number | null;
|
|
5162
|
+
} | null;
|
|
5163
|
+
priceComparers: {
|
|
5164
|
+
/** @description Whether source filter is active */
|
|
5165
|
+
active: "y" | "n";
|
|
5166
|
+
/** @description Id of service of given source */
|
|
5167
|
+
id: number | null;
|
|
5168
|
+
} | null;
|
|
5169
|
+
affiliate: {
|
|
5170
|
+
/** @description Whether source filter is active */
|
|
5171
|
+
active: "y" | "n";
|
|
5172
|
+
/** @description Id of service of given source */
|
|
5173
|
+
id: number | null;
|
|
5174
|
+
} | null;
|
|
5175
|
+
cpa: {
|
|
5176
|
+
/** @description Whether source filter is active */
|
|
5177
|
+
active: "y" | "n";
|
|
5178
|
+
/** @description Id of service of given source */
|
|
5179
|
+
id: number | null;
|
|
5180
|
+
} | null;
|
|
5181
|
+
newsletter: {
|
|
5182
|
+
/** @description Whether source filter is active */
|
|
5183
|
+
active: "y" | "n";
|
|
5184
|
+
/** @description Id of service of given source */
|
|
5185
|
+
id: number | null;
|
|
5186
|
+
} | null;
|
|
5187
|
+
social: {
|
|
5188
|
+
/** @description Whether source filter is active */
|
|
5189
|
+
active: "y" | "n";
|
|
5190
|
+
/** @description Id of service of given source */
|
|
5191
|
+
id: number | null;
|
|
5192
|
+
} | null;
|
|
5193
|
+
page: {
|
|
5194
|
+
/** @description Whether source filter is active */
|
|
5195
|
+
active: "y" | "n";
|
|
5196
|
+
/** @description Id of service of given source */
|
|
5197
|
+
id: number | null;
|
|
5198
|
+
} | null;
|
|
5199
|
+
};
|
|
5200
|
+
/** @description List of variables that can be used in a body template. */
|
|
5201
|
+
variables: {
|
|
5202
|
+
name: string;
|
|
5203
|
+
/** @enum {string} */
|
|
5204
|
+
source: "session" | "cookie";
|
|
5205
|
+
}[];
|
|
5206
|
+
}[];
|
|
5207
|
+
pagination: PagedResponse;
|
|
5208
|
+
};
|
|
5209
|
+
|
|
5210
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
5211
|
+
export type GetVouchersTypesResponse = {
|
|
5212
|
+
/** @description List of all discount code campaigns defined in the administration panel */
|
|
5213
|
+
vouchersTypes: {
|
|
5214
|
+
/** @description Discount code campaign ID */
|
|
5215
|
+
voucherTypeId: number;
|
|
5216
|
+
/** @description Discount code campaign name */
|
|
5217
|
+
voucherTypeName: string;
|
|
5218
|
+
}[];
|
|
5219
|
+
} & PagedResponse;
|
|
5220
|
+
|
|
5221
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
5222
|
+
export type GetVouchersResponse = {
|
|
5223
|
+
/** @description Parameters concerning returned results */
|
|
5224
|
+
result: {
|
|
5225
|
+
voucherData: {
|
|
5226
|
+
/** @description Voucher ID */
|
|
5227
|
+
id: number;
|
|
5228
|
+
/** @description Number. */
|
|
5229
|
+
number: string;
|
|
5230
|
+
/** @description Name. */
|
|
5231
|
+
name: string;
|
|
5232
|
+
/** @description Voucher expiration date */
|
|
5233
|
+
expirationDate: string;
|
|
5234
|
+
/** @description Voucher balance */
|
|
5235
|
+
balance: {
|
|
5236
|
+
/** @description Available balance */
|
|
5237
|
+
amount: number;
|
|
5238
|
+
/** @description Currency. */
|
|
5239
|
+
currency: string;
|
|
5240
|
+
};
|
|
5241
|
+
/** @description List of shops the voucher is active in */
|
|
5242
|
+
shops: number[];
|
|
5243
|
+
/** @example note */
|
|
5244
|
+
note: string;
|
|
5245
|
+
/** @description Status list: "y" - used, "n" - unused, "b" - blocked, "unverified" - awaiting approval */
|
|
5246
|
+
status: string;
|
|
5247
|
+
/** @description Is active? */
|
|
5248
|
+
blocked: "0" | "1";
|
|
5249
|
+
};
|
|
5250
|
+
/** @description Error code. List of error codes: "0" - Operation was successful, "1" - Login failure: invalid username or key, "123" - Error occurred when retrieving voucher data */
|
|
5251
|
+
faultCode: number;
|
|
5252
|
+
/** @description Error description. */
|
|
5253
|
+
faultString: string;
|
|
5254
|
+
}[];
|
|
5255
|
+
} & PagedResponse;
|
|
5256
|
+
|
|
5257
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
5258
|
+
export type GetOrdersHistoryResponse = {
|
|
5259
|
+
/** @description List of events */
|
|
5260
|
+
historyEvents: {
|
|
5261
|
+
/** @description Date when the event occurred */
|
|
5262
|
+
eventDate: string;
|
|
5263
|
+
/** @description Login */
|
|
5264
|
+
username: string;
|
|
5265
|
+
/** @description Event details */
|
|
5266
|
+
eventDetails: string;
|
|
5267
|
+
}[];
|
|
5268
|
+
};
|
|
5269
|
+
|
|
5270
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
5271
|
+
export type GetSnippetsCampaignResponse = {
|
|
5272
|
+
results: {
|
|
5273
|
+
/** @description Snippet campaign id */
|
|
5274
|
+
id: number | null;
|
|
5275
|
+
/** @description Snippet campaign name */
|
|
5276
|
+
name: string;
|
|
5277
|
+
/** @description Snippet campaign internal description */
|
|
5278
|
+
description: string;
|
|
5279
|
+
/** @description Shop ids where code snippets are active 1 ] */
|
|
5280
|
+
shop: number[] | null;
|
|
5281
|
+
/** @description Whether the snippet is active */
|
|
5282
|
+
active: "y" | "n";
|
|
5283
|
+
/** @description Whether the snippet campaign is deleted */
|
|
5284
|
+
readonly deleted: "y" | "n";
|
|
5285
|
+
/** @description Snippet order. */
|
|
5286
|
+
order: number;
|
|
5287
|
+
/** @description Number of code snippets associated with the campaign. */
|
|
5288
|
+
readonly snippetCount: number | null;
|
|
5289
|
+
/** @description Number of active code snippets associated with the campaign. */
|
|
5290
|
+
readonly activeSnippetCount: number | null;
|
|
5291
|
+
configVariables: {
|
|
5292
|
+
/** @description Key of config value. */
|
|
5293
|
+
key: string;
|
|
5294
|
+
/** @description Name of config item. */
|
|
5295
|
+
readonly name: string;
|
|
5296
|
+
/** @description Value of config item. */
|
|
5297
|
+
value: string;
|
|
5298
|
+
}[];
|
|
5299
|
+
}[];
|
|
5300
|
+
pagination: PagedResponse;
|
|
5301
|
+
};
|
|
5302
|
+
|
|
5303
|
+
/** @version v6.3 Typechecked 2025-08-25 */
|
|
5304
|
+
export type GetSnippetsCookiesResponse = {
|
|
5305
|
+
results: {
|
|
5306
|
+
/** @description Snippet */
|
|
5307
|
+
id: number | null;
|
|
5308
|
+
/** @description Id of the snippet code. */
|
|
5309
|
+
snippetId: number;
|
|
5310
|
+
/** @description Name of the cookie vendor. */
|
|
5311
|
+
deliverer: string;
|
|
5312
|
+
/** @description Category of the cookie */
|
|
5313
|
+
category: "analytics" | "marketing" | "functional";
|
|
5314
|
+
/** @description Cookie description for each language. */
|
|
5315
|
+
description: {
|
|
5316
|
+
/** @description Language code. */
|
|
5317
|
+
lang: string;
|
|
5318
|
+
/** @example Hello world */
|
|
5319
|
+
body: string;
|
|
5320
|
+
}[];
|
|
5321
|
+
/** @description Name of the cookie. */
|
|
5322
|
+
name: string | null;
|
|
5323
|
+
/** @description Type of the cookie
|
|
5324
|
+
|null} */
|
|
5325
|
+
type: "cookie" | "pixel" | "localStorage" | null;
|
|
5326
|
+
/** @description Cookie lifetime mode
|
|
5327
|
+
|null} */
|
|
5328
|
+
lifeTimeType: "temporary" | "days" | "minutes" | null;
|
|
5329
|
+
/** @description Cookie lifetime */
|
|
5330
|
+
lifeTime: number | null;
|
|
5331
|
+
}[];
|
|
5332
|
+
pagination: PagedResponse;
|
|
5333
|
+
};
|
|
5334
|
+
|
|
5335
|
+
/** @version v6.3 Typechecked 2025-08-26 */
|
|
5336
|
+
export type PostOrdersResponse = {
|
|
5337
|
+
results: {
|
|
5338
|
+
/** @description List of orders returned in gate call. */
|
|
5339
|
+
ordersResults: {
|
|
5340
|
+
/** @description Error code. */
|
|
5341
|
+
faultCode: number;
|
|
5342
|
+
/** @description Error description. */
|
|
5343
|
+
faultString: string;
|
|
5344
|
+
/** @description Order ID. */
|
|
5345
|
+
orderId: string;
|
|
5346
|
+
/** @description Order serial number. */
|
|
5347
|
+
orderSerialNumber?: number;
|
|
5348
|
+
/** @description The list of products returned due to a gate call */
|
|
5349
|
+
productsResults: null | {
|
|
5350
|
+
/** @description Product IAI code */
|
|
5351
|
+
productId: number;
|
|
5352
|
+
/** @description Size identifier */
|
|
5353
|
+
sizeId: string;
|
|
5354
|
+
/** @description External product system code for size. */
|
|
5355
|
+
productSizeCodeExternal: string;
|
|
5356
|
+
/** @description Stock ID */
|
|
5357
|
+
stockId?: number;
|
|
5358
|
+
/** @description Item in basket. */
|
|
5359
|
+
basketPosition: number;
|
|
5360
|
+
/** @description Error code. */
|
|
5361
|
+
faultCode: number;
|
|
5362
|
+
/** @description Error description. */
|
|
5363
|
+
faultString: string;
|
|
5364
|
+
}[];
|
|
5365
|
+
}[];
|
|
5366
|
+
};
|
|
5367
|
+
};
|
|
5368
|
+
|
|
5369
|
+
/** @version v6.3 Typechecked 2025-08-26 */
|
|
5370
|
+
export type PostProductsResponse = {
|
|
5371
|
+
/** @description Object contains detailed information on result of operation. */
|
|
5372
|
+
results: {
|
|
5373
|
+
/** @description The list of products returned due to a gate call */
|
|
5374
|
+
productsResults: {
|
|
5375
|
+
/** @description Product IAI code */
|
|
5376
|
+
productId: number;
|
|
5377
|
+
/** @description Size identifier */
|
|
5378
|
+
sizeId: string | null;
|
|
5379
|
+
/** @description External product system code for size. */
|
|
5380
|
+
productSizeCodeExternal: string | null;
|
|
5381
|
+
/** @description Element containing details of the error. */
|
|
5382
|
+
faults?: {
|
|
5383
|
+
/** @description Error code. */
|
|
5384
|
+
faultCode: string;
|
|
5385
|
+
/** @description Error description. */
|
|
5386
|
+
faultString: string;
|
|
5387
|
+
}[];
|
|
5388
|
+
/** @description Object contains detailed information on performed operation. */
|
|
5389
|
+
productResultDetails?: {
|
|
5390
|
+
/** @description Stock ID */
|
|
5391
|
+
stockId?: number;
|
|
5392
|
+
/** @description Product stock quantity */
|
|
5393
|
+
productSizeQuantity?: number;
|
|
5394
|
+
/** @description Shop Id */
|
|
5395
|
+
shopId?: number;
|
|
5396
|
+
/** @description Size identifier */
|
|
5397
|
+
sizeId?: string;
|
|
5398
|
+
/** @description Operation type */
|
|
5399
|
+
operationType?: string;
|
|
5400
|
+
/** @description Element containing details of the error. */
|
|
5401
|
+
fault?: {
|
|
5402
|
+
/** @description Error code. */
|
|
5403
|
+
faultCode: string;
|
|
5404
|
+
/** @description Error description. */
|
|
5405
|
+
faultString: string;
|
|
5406
|
+
};
|
|
5407
|
+
existingCodes?: {
|
|
5408
|
+
[code: string]: {
|
|
5409
|
+
/** @description Product IAI code */
|
|
5410
|
+
productId: number;
|
|
5411
|
+
/** @description Size identifier */
|
|
5412
|
+
sizeId: string;
|
|
5413
|
+
/** @description External product system code for size. */
|
|
5414
|
+
productSizeCodeExternal: string;
|
|
5415
|
+
/** @description Producer code */
|
|
5416
|
+
productProducerCode: string
|
|
5417
|
+
} | []
|
|
5418
|
+
};
|
|
5419
|
+
}[];
|
|
5420
|
+
}[];
|
|
5421
|
+
};
|
|
5422
|
+
};
|
|
5423
|
+
|
|
5424
|
+
/** @version v6.3 Typechecked 2025-08-26 */
|
|
5425
|
+
export type PutProductsResponse = {
|
|
5426
|
+
/** @description Object contains detailed information on result of operation. */
|
|
5427
|
+
results: {
|
|
5428
|
+
/** @description The list of products returned due to a gate call */
|
|
5429
|
+
productsResults: {
|
|
5430
|
+
/** @description Product IAI code */
|
|
5431
|
+
productId: number;
|
|
5432
|
+
/** @description One of the unique, indexed product codes (IAI code / External system code / Producer code) */
|
|
5433
|
+
productIndex?: string;
|
|
5434
|
+
promoteStatus?: {
|
|
5435
|
+
/** @description Is attribute set */
|
|
5436
|
+
promoteIsEnabled: boolean;
|
|
5437
|
+
/** @description Strikethrough price */
|
|
5438
|
+
promoteItemNormalPrice: number;
|
|
5439
|
+
/** @description Gross price */
|
|
5440
|
+
productRetailPrice: number;
|
|
5441
|
+
};
|
|
5442
|
+
/** @description Size identifier */
|
|
5443
|
+
sizeId: string | null;
|
|
5444
|
+
/** @description External product system code for size. */
|
|
5445
|
+
productSizeCodeExternal: string | null;
|
|
5446
|
+
/** @description Element containing details of the error. */
|
|
5447
|
+
faults: {
|
|
5448
|
+
/** @description Error code. */
|
|
5449
|
+
faultCode: string;
|
|
5450
|
+
/** @description Error description. */
|
|
5451
|
+
faultString: string;
|
|
5452
|
+
}[];
|
|
5453
|
+
/** @description Object contains detailed information on performed operation. */
|
|
5454
|
+
productResultDetails: {
|
|
5455
|
+
/** @description Stock ID */
|
|
5456
|
+
stockId: number;
|
|
5457
|
+
/** @description Product stock quantity */
|
|
5458
|
+
productSizeQuantity: number;
|
|
5459
|
+
/** @description Shop Id */
|
|
5460
|
+
shopId: number;
|
|
5461
|
+
/** @description Size identifier */
|
|
5462
|
+
sizeId: string;
|
|
5463
|
+
/** @description Operation type */
|
|
5464
|
+
operationType: string;
|
|
5465
|
+
/** @description Element containing details of the error. */
|
|
5466
|
+
fault: {
|
|
5467
|
+
/** @description Error code. */
|
|
5468
|
+
faultCode: string;
|
|
5469
|
+
/** @description Error description. */
|
|
5470
|
+
faultString: string;
|
|
5471
|
+
};
|
|
5472
|
+
existingCodes: {
|
|
5473
|
+
/** @description Product IAI code */
|
|
5474
|
+
productId: number;
|
|
5475
|
+
/** @description Size identifier */
|
|
5476
|
+
sizeId: string;
|
|
5477
|
+
/** @description External product system code for size. */
|
|
5478
|
+
productSizeCodeExternal: string;
|
|
5479
|
+
/** @description Producer code */
|
|
5480
|
+
productProducerCode: string;
|
|
5481
|
+
}[];
|
|
5482
|
+
}[];
|
|
5483
|
+
}[];
|
|
5484
|
+
};
|
|
5485
|
+
};
|
|
5486
|
+
|
|
5487
|
+
/** @version v6.3 Typechecked 2025-08-26 */
|
|
5488
|
+
export type PutOrdersResponse = {
|
|
5489
|
+
results: {
|
|
5490
|
+
/** @description List of orders returned in gate call. */
|
|
5491
|
+
ordersResults: {
|
|
5492
|
+
/** @description Order ID. */
|
|
5493
|
+
orderId: string;
|
|
5494
|
+
/** @description Order serial number. */
|
|
5495
|
+
orderSerialNumber: number;
|
|
5496
|
+
/** @description Order status. Allowed values: "finished_ext" - order status: completed in FA application, "finished" - completed, "new" - not handled, "payment_waiting" - awaiting payment, "delivery_waiting" - awaiting delivery, "on_order" - in progress, "packed" - being picked, "packed_fulfillment" - being picked - fulfilment, "packed_ready" - packed, "ready" - ready, "wait_for_dispatch" - awaiting dispatch date, "suspended" - on hold, "joined" - merged, "missing" - missing, "lost" - lost, "false" - false, "canceled" - Customer canceled. */
|
|
5497
|
+
orderStatus: string;
|
|
5498
|
+
/** @description Order status id . */
|
|
5499
|
+
orderStatusId: number;
|
|
5500
|
+
/** @description The list of products returned due to a gate call */
|
|
5501
|
+
productsResults?: {
|
|
5502
|
+
/** @description Product IAI code */
|
|
5503
|
+
productId: number;
|
|
5504
|
+
/** @description Size identifier */
|
|
5505
|
+
sizeId: string;
|
|
5506
|
+
/** @description External product system code for size. */
|
|
5507
|
+
productSizeCodeExternal: string;
|
|
5508
|
+
/** @description Item in basket. */
|
|
5509
|
+
basketPosition: number;
|
|
5510
|
+
/** @description Stock ID */
|
|
5511
|
+
stockId: number;
|
|
5512
|
+
/** @description Error code. List of error codes: 0 - Operation was successful, 1 - Not specified Id or serial number of the order, 2 - Order status entered in call parameters is not handled by the gate, 3 - Customer has not been informed about order status change, 4 - An error occurred during attempt to change order status., 5 - No such status, 6 - If you want to merge orders, use the tool provided by IdoSell Shop, 10 - Balance of payments made by customer for this order does not equal its value. Organize status of payments and try to change order status again., 11 - You cannot fulfill the order, because products are not removed from the stock. Remove the products first., 13 - You cannot send order, because not all product have been transferred from supplier stock., 14 - Balance of payments made by customer for this order does not equal its value. Organize status of payments and try to change order status again., 15 - There are payments registered for this order. Sort status of payments and try again to change the status of order., There are not registered payments for this order. Organize status of payments and try changing order status again., 16 - Order can't be completed by supplier as not all products are from foreign stock, Order cannot be sent. Check reservations and stock quantities., 18 - Ccustomers VAT settings have not been approved yet. To change the status of order confirm settings or charge VAT., 19 - There are products in order bought within presale., 19 - Order cannot be sent. There are products in order bought within presale., 20 - Not all products have been moved to target stock., 21 - You cannot complete order, , 22 - You can't send orders as there are products in it for which serial numbers were not saved, 23 - Order cannot be sent. Not all products have been moved to target stock., 24 - There are sale documents issued to this order. Cancel issued documents and change status next., 25 - Not all of documents demanded by customer have been issued., 2214 - Order status cannot be changed, 26 - Order status cannot be changed. List of products causing problems, 27 - Change of a billing currency is possible only in case of open orders which have neither any issued invoices (or all invoices have the status "cancelled") nor declared or completed payments., 28 - Invalid currency, 29 - Wrong sale date format 32 - Invalid order calculation parameter 33 - Incorrect loyalty point value for a product 34 - Customer does not have enough loyalty points 36 - Incorrect VAT rate of the product */
|
|
5513
|
+
faultCode: number;
|
|
5514
|
+
/** @description Error description. */
|
|
5515
|
+
faultString: string;
|
|
5516
|
+
}[];
|
|
5517
|
+
/** @description Error code. List of error codes: 0 - Operation was successful, 1 - Not specified Id or serial number of the order, 2 - Order status entered in call parameters is not handled by the gate, 3 - Customer has not been informed about order status change, 4 - An error occurred during attempt to change order status., 5 - No such status, 6 - If you want to merge orders, use the tool provided by IdoSell Shop, 10 - Balance of payments made by customer for this order does not equal its value. Organize status of payments and try to change order status again., 11 - You cannot fulfill the order, because products are not removed from the stock. Remove the products first., 13 - You cannot send order, because not all product have been transferred from supplier stock., 14 - Balance of payments made by customer for this order does not equal its value. Organize status of payments and try to change order status again., 15 - There are payments registered for this order. Sort status of payments and try again to change the status of order., There are not registered payments for this order. Organize status of payments and try changing order status again., 16 - Order can't be completed by supplier as not all products are from foreign stock, Order cannot be sent. Check reservations and stock quantities., 18 - Ccustomers VAT settings have not been approved yet. To change the status of order confirm settings or charge VAT., 19 - There are products in order bought within presale., 19 - Order cannot be sent. There are products in order bought within presale., 20 - Not all products have been moved to target stock., 21 - You cannot complete order, , 22 - You can't send orders as there are products in it for which serial numbers were not saved, 23 - Order cannot be sent. Not all products have been moved to target stock., 24 - There are sale documents issued to this order. Cancel issued documents and change status next., 25 - Not all of documents demanded by customer have been issued., 2214 - Order status cannot be changed, 26 - Order status cannot be changed. List of products causing problems, 27 - Change of a billing currency is possible only in case of open orders which have neither any issued invoices (or all invoices have the status "cancelled") nor declared or completed payments., 28 - Invalid currency, 29 - Wrong sale date format 32 - Invalid order calculation parameter 33 - Incorrect loyalty point value for a product 34 - Customer does not have enough loyalty points 36 - Incorrect VAT rate of the product */
|
|
5518
|
+
faultCode: number;
|
|
5519
|
+
/** @description Error description. */
|
|
5520
|
+
faultString: string;
|
|
5521
|
+
}[];
|
|
5522
|
+
};
|
|
5523
|
+
};
|
|
5524
|
+
|
|
5525
|
+
/** @version v6.3 Typechecked 2025-08-26 */
|
|
5526
|
+
export type PostCouriersPickupPointsResponse = {
|
|
5527
|
+
/** @description Parameters concerning returned results */
|
|
5528
|
+
result: {
|
|
5529
|
+
/** @description Collection point ID. */
|
|
5530
|
+
pickupPointId: number;
|
|
5531
|
+
/** @description external system code. */
|
|
5532
|
+
pickupPointExternalId: string;
|
|
5533
|
+
/** @description Courier ID. */
|
|
5534
|
+
courierId: number;
|
|
5535
|
+
/** @description Error code. */
|
|
5536
|
+
faultCode: number;
|
|
5537
|
+
/** @description Error description. */
|
|
5538
|
+
faultString: string;
|
|
5539
|
+
}[];
|
|
5540
|
+
};
|
|
5541
|
+
|
|
5542
|
+
/** @version v6.3 Typechecked 2025-08-26 */
|
|
5543
|
+
export type PutCouriersPickupPointsResponse = {
|
|
5544
|
+
/** @description Parameters concerning returned results */
|
|
5545
|
+
result: {
|
|
5546
|
+
/** @description Collection point ID. */
|
|
5547
|
+
pickupPointId: number;
|
|
5548
|
+
/** @description external system code. */
|
|
5549
|
+
pickupPointExternalId: string;
|
|
5550
|
+
/** @description Courier ID. */
|
|
5551
|
+
courierId: number;
|
|
5552
|
+
/** @description Error code. */
|
|
5553
|
+
faultCode: number;
|
|
5554
|
+
/** @description Error description. */
|
|
5555
|
+
faultString: string;
|
|
5556
|
+
}[];
|
|
5557
|
+
};
|
|
5558
|
+
|
|
5559
|
+
export type PostPackagesLabelsResponse = {
|
|
5560
|
+
/** @description Id. */
|
|
5561
|
+
eventId: number;
|
|
5562
|
+
/** @description Type. */
|
|
5563
|
+
eventType: string;
|
|
5564
|
+
/** @description Information on consignments. */
|
|
5565
|
+
packages: {
|
|
5566
|
+
/** @description Parcel ID in the panel */
|
|
5567
|
+
id: string;
|
|
5568
|
+
/** @description Shipment number provided by the courier. Returned only if the courier supports tracking numbers */
|
|
5569
|
+
shippingNumber?: string;
|
|
5570
|
+
/** @description Number of the parcel in the shipmnet given by the courier. Returned only if the courier supports parcel numbers */
|
|
5571
|
+
packageNumber: string;
|
|
5572
|
+
}[];
|
|
5573
|
+
/** @description Package labels encoded in base64 */
|
|
5574
|
+
labels: {
|
|
5575
|
+
/** @description Parcel label encoded with base64 algorythm. */
|
|
5576
|
+
label: string;
|
|
5577
|
+
/** @description Label format */
|
|
5578
|
+
format: "PDF" | "A4" | "16x10" | "EPL" | "ZPL" | "SPL";
|
|
5579
|
+
};
|
|
5580
|
+
};
|
|
5581
|
+
|
|
5582
|
+
export type PostOrdersDocumentsCreateResponse = {
|
|
5583
|
+
documentsResults: {
|
|
5584
|
+
documentsData: {
|
|
5585
|
+
/** @description Document type */
|
|
5586
|
+
documentType: "vat_invoice" | "corrective_vat_invoice" | "advance_vat_invoice" | "final_advance_vat_invoice" | "pro_forma_invoice" | "advance_pro_forma_invoice" | "final_advance_pro_forma_invoice" | "fiscalInvoice" | "invoices" | "fiscal_receipt" | "sales_confirmation";
|
|
5587
|
+
/** @description Order serial number */
|
|
5588
|
+
orderSerialNumber: number;
|
|
5589
|
+
/** @example */
|
|
5590
|
+
id?: number;
|
|
5591
|
+
/** @example */
|
|
5592
|
+
documentNumber?: string;
|
|
5593
|
+
/** @example */
|
|
5594
|
+
documentData?: string;
|
|
5595
|
+
error: {
|
|
5596
|
+
/** @description Error code. */
|
|
5597
|
+
faultCode: number;
|
|
5598
|
+
/** @description Error description. */
|
|
5599
|
+
faultString: string;
|
|
5600
|
+
};
|
|
5601
|
+
}[];
|
|
5602
|
+
pdfBase64: string;
|
|
5603
|
+
};
|
|
5604
|
+
};
|
|
5605
|
+
|
|
4911
5606
|
export { };
|