idosell 0.3.17 → 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/changelog.md +6 -0
- package/dist/app.d.ts +4 -4
- package/dist/gates.js +2 -0
- package/dist/gateways.d.ts +232 -214
- package/dist/index.js +2 -2
- package/dist/methods/getEntries.js +1 -0
- package/dist/methods/getOrdersStatuses.js +5 -0
- package/dist/methods/searchOrders.js +1 -1
- package/dist/methods/searchOrdersUnfinished.js +1 -1
- package/dist/reqparams.d.ts +2260 -0
- package/dist/responses.d.ts +2240 -42
- 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
|
@@ -27,7 +27,7 @@ type FaultCodeString = {
|
|
|
27
27
|
faultString: string;
|
|
28
28
|
}
|
|
29
29
|
|
|
30
|
-
/** Typechecked 2025-08-02 */
|
|
30
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
31
31
|
export type SearchOrdersResponse = {
|
|
32
32
|
Results: {
|
|
33
33
|
/** @description Order ID. */
|
|
@@ -195,7 +195,7 @@ export type SearchOrdersResponse = {
|
|
|
195
195
|
/** @example receivedDate */
|
|
196
196
|
receivedDate: string;
|
|
197
197
|
/** @description Order handling time in seconds. */
|
|
198
|
-
orderPrepareTime: number
|
|
198
|
+
orderPrepareTime: number;
|
|
199
199
|
/** @description Customer comments on order. */
|
|
200
200
|
clientNoteToOrder: string;
|
|
201
201
|
/** @description Customer remarks for courier. */
|
|
@@ -478,7 +478,7 @@ export type SearchOrdersResponse = {
|
|
|
478
478
|
}[];
|
|
479
479
|
} & PagedResponse;
|
|
480
480
|
|
|
481
|
-
/** Typechecked 2025-08-02 */
|
|
481
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
482
482
|
export type SearchProductsResponse = {
|
|
483
483
|
/** @description Object contains detailed information on result of operation. */
|
|
484
484
|
results: {
|
|
@@ -1536,7 +1536,7 @@ export type SearchProductsResponse = {
|
|
|
1536
1536
|
}[];
|
|
1537
1537
|
}[];
|
|
1538
1538
|
/** @description Parameter values */
|
|
1539
|
-
parameterValues
|
|
1539
|
+
parameterValues?: {
|
|
1540
1540
|
/** @description Parameter value ID */
|
|
1541
1541
|
parameterValueId: number;
|
|
1542
1542
|
/** @description Language data */
|
|
@@ -1588,7 +1588,7 @@ export type SearchProductsResponse = {
|
|
|
1588
1588
|
/** @description #!DaneIndywidualnychAdresowURLDlaSklepow!# */
|
|
1589
1589
|
productIndividualUrlsData?: {
|
|
1590
1590
|
/** @description Shop Id */
|
|
1591
|
-
shopId:
|
|
1591
|
+
shopId: number;
|
|
1592
1592
|
/** @description Language ID */
|
|
1593
1593
|
langId: string;
|
|
1594
1594
|
/** @example url */
|
|
@@ -1757,12 +1757,12 @@ type ProductParameter = {
|
|
|
1757
1757
|
parameterValueIds: number[];
|
|
1758
1758
|
}
|
|
1759
1759
|
|
|
1760
|
-
/** Typechecked 2025-08-02 */
|
|
1760
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
1761
1761
|
export type SearchProductsParametersResponse = {
|
|
1762
1762
|
parametersResult: Record<string, ProductParameter>;
|
|
1763
1763
|
} & PagedResponse;
|
|
1764
1764
|
|
|
1765
|
-
/** Typechecked 2025-08-02 */
|
|
1765
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
1766
1766
|
export type SearchClientsCrmResponse = {
|
|
1767
1767
|
/** @description List of customers. */
|
|
1768
1768
|
clientsResults: {
|
|
@@ -1876,7 +1876,7 @@ export type SearchClientsCrmResponse = {
|
|
|
1876
1876
|
}[];
|
|
1877
1877
|
/** @description Information about customer balance. */
|
|
1878
1878
|
clientBalances: {
|
|
1879
|
-
[
|
|
1879
|
+
[currency: string]: {
|
|
1880
1880
|
/** @description Balance value. */
|
|
1881
1881
|
clientBalanceAmount: number;
|
|
1882
1882
|
/** @description Currency ID */
|
|
@@ -1951,7 +1951,7 @@ export type SearchClientsCrmResponse = {
|
|
|
1951
1951
|
}[];
|
|
1952
1952
|
} & PagedResponse;
|
|
1953
1953
|
|
|
1954
|
-
/** Typechecked 2025-08-02 */
|
|
1954
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
1955
1955
|
export type SearchPackagesResponse = {
|
|
1956
1956
|
/** @description Object contains detailed information on result of operation. */
|
|
1957
1957
|
results: {
|
|
@@ -2038,8 +2038,8 @@ export type SearchPackagesResponse = {
|
|
|
2038
2038
|
}[];
|
|
2039
2039
|
};
|
|
2040
2040
|
|
|
2041
|
-
/** Typechecked 2025-08-02 */
|
|
2042
|
-
export type
|
|
2041
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2042
|
+
export type SearchProductsCategoriesIdosellResponse = {
|
|
2043
2043
|
/** @description List of IdoSell Categories */
|
|
2044
2044
|
categoriesIdoSell: {
|
|
2045
2045
|
/** @description IdoSell Category ID */
|
|
@@ -2062,8 +2062,8 @@ export type SearchCategoriesIdosellResponse = {
|
|
|
2062
2062
|
}[];
|
|
2063
2063
|
} & PagedResponse;
|
|
2064
2064
|
|
|
2065
|
-
/** Typechecked 2025-08-02 */
|
|
2066
|
-
export type
|
|
2065
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2066
|
+
export type SearchOrdersOpinionsResponse = {
|
|
2067
2067
|
/** @description Object contains detailed information on result of operation. */
|
|
2068
2068
|
results: {
|
|
2069
2069
|
/** @example 1 */
|
|
@@ -2129,8 +2129,8 @@ export type SearchOpinionsResponse = {
|
|
|
2129
2129
|
}[];
|
|
2130
2130
|
} & PagedResponse;
|
|
2131
2131
|
|
|
2132
|
-
/** Typechecked 2025-08-02 */
|
|
2133
|
-
export type
|
|
2132
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2133
|
+
export type SearchProductsDeliveryTimeResponse = {
|
|
2134
2134
|
/** @description Object contains detailed information on result of operation. */
|
|
2135
2135
|
results: {
|
|
2136
2136
|
/** @description Product IAI code */
|
|
@@ -2156,7 +2156,7 @@ export type SearchDeliveryTimeResponse = {
|
|
|
2156
2156
|
}[];
|
|
2157
2157
|
};
|
|
2158
2158
|
|
|
2159
|
-
export type
|
|
2159
|
+
export type SearchClientsGiftcardsResponse = {
|
|
2160
2160
|
result: ({
|
|
2161
2161
|
/** @description Gift card data */
|
|
2162
2162
|
giftCardData: {
|
|
@@ -2208,18 +2208,18 @@ type SearchNewsletterResponse<T> = {
|
|
|
2208
2208
|
} & T)[];
|
|
2209
2209
|
} & PagedSnakecaseResponse;
|
|
2210
2210
|
|
|
2211
|
-
export type
|
|
2211
|
+
export type SearchClientsNewsletterEmailResponse = SearchNewsletterResponse<{
|
|
2212
2212
|
/** @description Customer e-mail address. */
|
|
2213
2213
|
email: string;
|
|
2214
2214
|
}>;
|
|
2215
2215
|
|
|
2216
|
-
export type
|
|
2216
|
+
export type SearchClientsNewsletterSmsResponse = SearchNewsletterResponse<{
|
|
2217
2217
|
/** @description Cell phone. */
|
|
2218
2218
|
phone_cellular: string;
|
|
2219
2219
|
}>;
|
|
2220
2220
|
|
|
2221
|
-
/** Typechecked 2025-08-02 */
|
|
2222
|
-
export type
|
|
2221
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2222
|
+
export type GetWmsStocksdocumentsProductsResponse = {
|
|
2223
2223
|
/** @description Products list. */
|
|
2224
2224
|
products: {
|
|
2225
2225
|
/** @description Stock keeping unit. */
|
|
@@ -2261,8 +2261,8 @@ export type GetStocksdocumentsProductsResponse = {
|
|
|
2261
2261
|
}[];
|
|
2262
2262
|
} & PagedSnakecaseResponse;
|
|
2263
2263
|
|
|
2264
|
-
/** Typechecked 2025-08-02 */
|
|
2265
|
-
export type
|
|
2264
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2265
|
+
export type GetWmsStocksdocumentsDocumentsResponse = {
|
|
2266
2266
|
/** @description List of documents. */
|
|
2267
2267
|
stocksDocuments: {
|
|
2268
2268
|
/** @description Document identifier. */
|
|
@@ -2321,7 +2321,7 @@ export type GetStocksdocumentsDocumentsResponse = {
|
|
|
2321
2321
|
}[];
|
|
2322
2322
|
} & PagedResponse;
|
|
2323
2323
|
|
|
2324
|
-
/** Typechecked 2025-08-02 */
|
|
2324
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2325
2325
|
export type GetClientsResponse = {
|
|
2326
2326
|
/** @description Object contains detailed information on result of operation. */
|
|
2327
2327
|
results: {
|
|
@@ -2443,7 +2443,7 @@ export type GetClientsResponse = {
|
|
|
2443
2443
|
}[];
|
|
2444
2444
|
} & PagedResponse;
|
|
2445
2445
|
|
|
2446
|
-
/** Typechecked 2025-08-02 */
|
|
2446
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2447
2447
|
export type GetReturnsResponse = {
|
|
2448
2448
|
/** @description Element that contains the list of found returns. */
|
|
2449
2449
|
returns: {
|
|
@@ -2585,7 +2585,7 @@ export type GetReturnsResponse = {
|
|
|
2585
2585
|
}[];
|
|
2586
2586
|
} & PagedSnakecaseResponse;
|
|
2587
2587
|
|
|
2588
|
-
/** Typechecked 2025-08-02 */
|
|
2588
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2589
2589
|
export type GetRmaResponse = {
|
|
2590
2590
|
/** @description Complaints. */
|
|
2591
2591
|
rmas: {
|
|
@@ -2678,8 +2678,8 @@ export type GetRmaResponse = {
|
|
|
2678
2678
|
isErrors: boolean;
|
|
2679
2679
|
} & PagedResponse;
|
|
2680
2680
|
|
|
2681
|
-
/** Typechecked 2025-08-02 */
|
|
2682
|
-
export type
|
|
2681
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2682
|
+
export type GetSystemConfigResponse = {
|
|
2683
2683
|
/** @example 1 */
|
|
2684
2684
|
client_id: number;
|
|
2685
2685
|
/** @description Dedicated server. */
|
|
@@ -2946,7 +2946,7 @@ export type GetConfigResponse = {
|
|
|
2946
2946
|
/** @description Small photo height in pixels. */
|
|
2947
2947
|
picture_small_height: number;
|
|
2948
2948
|
};
|
|
2949
|
-
|
|
2949
|
+
price_comparers: {
|
|
2950
2950
|
[id: string]: {
|
|
2951
2951
|
/** @description Id */
|
|
2952
2952
|
id?: number;
|
|
@@ -2986,8 +2986,8 @@ export type GetConfigResponse = {
|
|
|
2986
2986
|
typeOfPrinterProtocolAdress: string;
|
|
2987
2987
|
};
|
|
2988
2988
|
|
|
2989
|
-
/** Typechecked 2025-08-02 */
|
|
2990
|
-
export type
|
|
2989
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
2990
|
+
export type GetSystemShopsDataResponse = Omit<GetConfigResponse, 'panel_settings'|'shops'> & {
|
|
2991
2991
|
/** @description Shop contact data */
|
|
2992
2992
|
shop_contact: {
|
|
2993
2993
|
/** @description shop ID */
|
|
@@ -3071,11 +3071,11 @@ export type GetShopsDataResponse = Omit<GetConfigResponse, 'panel_settings'|'sho
|
|
|
3071
3071
|
}[];
|
|
3072
3072
|
};
|
|
3073
3073
|
|
|
3074
|
-
/** Typechecked 2025-08-02 */
|
|
3074
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3075
3075
|
export type GetSizechartsResponse = {
|
|
3076
3076
|
sizeCharts: {
|
|
3077
3077
|
[id: string]: {
|
|
3078
|
-
|
|
3078
|
+
/** @description Id */
|
|
3079
3079
|
id: number;
|
|
3080
3080
|
/** @description Name in panel */
|
|
3081
3081
|
nameInPanel: string;
|
|
@@ -3094,7 +3094,7 @@ export type GetSizechartsResponse = {
|
|
|
3094
3094
|
} | [];
|
|
3095
3095
|
/** @description List of sizes */
|
|
3096
3096
|
sizes?: {
|
|
3097
|
-
[
|
|
3097
|
+
[size: string]: {
|
|
3098
3098
|
/** @description Size identifier */
|
|
3099
3099
|
sizeId: string;
|
|
3100
3100
|
/** @description Priority */
|
|
@@ -3110,12 +3110,12 @@ export type GetSizechartsResponse = {
|
|
|
3110
3110
|
}
|
|
3111
3111
|
} | [];
|
|
3112
3112
|
}[];
|
|
3113
|
-
}
|
|
3113
|
+
};
|
|
3114
3114
|
} | [];
|
|
3115
3115
|
} & PagedResponse;
|
|
3116
3116
|
|
|
3117
|
-
/** Typechecked 2025-08-02 */
|
|
3118
|
-
export type
|
|
3117
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3118
|
+
export type GetWmsLocationsResponse = {
|
|
3119
3119
|
/** @description Object contains detailed information on result of operation. */
|
|
3120
3120
|
results: {
|
|
3121
3121
|
/** @description Warehouse location ID */
|
|
@@ -3142,7 +3142,7 @@ export type GetLocationsResponse = {
|
|
|
3142
3142
|
}[];
|
|
3143
3143
|
} & PagedResponse;
|
|
3144
3144
|
|
|
3145
|
-
/** Typechecked 2025-08-02 */
|
|
3145
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3146
3146
|
export type GetWarrantiesResponse = {
|
|
3147
3147
|
warranties: {
|
|
3148
3148
|
/** @description Warranty language id (numeric). */
|
|
@@ -3168,8 +3168,8 @@ export type GetWarrantiesResponse = {
|
|
|
3168
3168
|
}[];
|
|
3169
3169
|
} & PagedSnakecaseResponse;
|
|
3170
3170
|
|
|
3171
|
-
/** Typechecked 2025-08-02 */
|
|
3172
|
-
export type
|
|
3171
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3172
|
+
export type GetProductsCategoriesResponse = {
|
|
3173
3173
|
last_changed_time: string;
|
|
3174
3174
|
/** @description Element containing a list of found results on a given page. */
|
|
3175
3175
|
categories: {
|
|
@@ -3216,7 +3216,7 @@ export type GetCategoriesResponse = {
|
|
|
3216
3216
|
}[];
|
|
3217
3217
|
} & PagedSnakecaseResponse;
|
|
3218
3218
|
|
|
3219
|
-
/** Typechecked 2025-08-02 */
|
|
3219
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3220
3220
|
export type GetMenuResponse = {
|
|
3221
3221
|
/** @description Parameters concerning returned results */
|
|
3222
3222
|
result: {
|
|
@@ -3327,7 +3327,8 @@ export type GetMenuResponse = {
|
|
|
3327
3327
|
}[];
|
|
3328
3328
|
};
|
|
3329
3329
|
|
|
3330
|
-
|
|
3330
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3331
|
+
export type GetOrdersAuctionDetailsResponse = {
|
|
3331
3332
|
/** @description External listings - orders table. */
|
|
3332
3333
|
auctions: {
|
|
3333
3334
|
/** @description Order ID. */
|
|
@@ -3375,6 +3376,7 @@ export type GetAuctionDetailsResponse = {
|
|
|
3375
3376
|
isErrors: boolean;
|
|
3376
3377
|
};
|
|
3377
3378
|
|
|
3379
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3378
3380
|
export type GetOrdersDocumentsResponse = {
|
|
3379
3381
|
/** @description List of documents. */
|
|
3380
3382
|
documents: {
|
|
@@ -3405,4 +3407,2200 @@ export type GetOrdersDocumentsResponse = {
|
|
|
3405
3407
|
}[];
|
|
3406
3408
|
};
|
|
3407
3409
|
|
|
3408
|
-
|
|
3410
|
+
/** @version v6.1 Typechecked 2025-08-06 */
|
|
3411
|
+
export type GetProductsStocksResponse = {
|
|
3412
|
+
/** @description Object contains detailed information on result of operation. */
|
|
3413
|
+
results: {
|
|
3414
|
+
ident: {
|
|
3415
|
+
/** */
|
|
3416
|
+
identType: "id" | "index" | "codeExtern" | "codeProducer";
|
|
3417
|
+
/** @description ID value. */
|
|
3418
|
+
identValue: string;
|
|
3419
|
+
};
|
|
3420
|
+
/** @description Error information. */
|
|
3421
|
+
error?: FaultCodeString;
|
|
3422
|
+
quantities?: {
|
|
3423
|
+
/** @description Stocks data. */
|
|
3424
|
+
stocks: {
|
|
3425
|
+
/** @description Stock ID. */
|
|
3426
|
+
stock_id: number;
|
|
3427
|
+
/** @description List of sizes */
|
|
3428
|
+
sizes: {
|
|
3429
|
+
/** @description Size identifier. */
|
|
3430
|
+
size_id: string;
|
|
3431
|
+
/** @description Size name. */
|
|
3432
|
+
size_name: string;
|
|
3433
|
+
/** @description External system code. */
|
|
3434
|
+
product_sizecode: string;
|
|
3435
|
+
/** @description Number of products in delivery. */
|
|
3436
|
+
quantity: number;
|
|
3437
|
+
/** @description Information of reservations. */
|
|
3438
|
+
reservations?: {
|
|
3439
|
+
/** @description Number of products reserved ad hoc. */
|
|
3440
|
+
adhoc: number;
|
|
3441
|
+
/** @description Number of products reserved for auctions. */
|
|
3442
|
+
auction: number;
|
|
3443
|
+
/** @description Number of products reserved for clients. */
|
|
3444
|
+
client: number;
|
|
3445
|
+
/** @description Number of products reserved for orders. */
|
|
3446
|
+
order: number;
|
|
3447
|
+
/** @description Number of products reserved for retail sales. */
|
|
3448
|
+
retail: number;
|
|
3449
|
+
/** @description Number of products reserved for wholesale sales. */
|
|
3450
|
+
wholesale: number;
|
|
3451
|
+
};
|
|
3452
|
+
}[];
|
|
3453
|
+
}[];
|
|
3454
|
+
/** @description Information on auction sites. */
|
|
3455
|
+
auctions?: {
|
|
3456
|
+
/** @description Stock ID. */
|
|
3457
|
+
stock_id: number;
|
|
3458
|
+
/** @description List of sizes */
|
|
3459
|
+
sizes: {
|
|
3460
|
+
/** @description Size identifier. */
|
|
3461
|
+
size_id: string;
|
|
3462
|
+
/** @description Size name. */
|
|
3463
|
+
size_name: string;
|
|
3464
|
+
/** @description External system code. */
|
|
3465
|
+
product_sizecode: string;
|
|
3466
|
+
/** @description Number of products in delivery. */
|
|
3467
|
+
quantity: number;
|
|
3468
|
+
/** @description Information of reservations. */
|
|
3469
|
+
reservations?: {
|
|
3470
|
+
/** @description Number of products reserved ad hoc. */
|
|
3471
|
+
adhoc: number;
|
|
3472
|
+
/** @description Number of products reserved for auctions. */
|
|
3473
|
+
auction: number;
|
|
3474
|
+
/** @description Number of products reserved for clients. */
|
|
3475
|
+
client: number;
|
|
3476
|
+
/** @description Number of products reserved for orders. */
|
|
3477
|
+
order: number;
|
|
3478
|
+
/** @description Number of products reserved for retail sales. */
|
|
3479
|
+
retail: number;
|
|
3480
|
+
/** @description Number of products reserved for wholesale sales. */
|
|
3481
|
+
wholesale: number;
|
|
3482
|
+
};
|
|
3483
|
+
}[];
|
|
3484
|
+
}[];
|
|
3485
|
+
/** @description Information on incomplete orders. */
|
|
3486
|
+
orders_unfinished?: {
|
|
3487
|
+
/** @description Stock ID. */
|
|
3488
|
+
stock_id: number;
|
|
3489
|
+
/** @description List of sizes */
|
|
3490
|
+
sizes: {
|
|
3491
|
+
/** @description Size identifier. */
|
|
3492
|
+
size_id: string;
|
|
3493
|
+
/** @description Size name. */
|
|
3494
|
+
size_name: string;
|
|
3495
|
+
/** @description External system code. */
|
|
3496
|
+
product_sizecode: string;
|
|
3497
|
+
/** @description Number of products in delivery. */
|
|
3498
|
+
quantity: number;
|
|
3499
|
+
/** @description Information of reservations. */
|
|
3500
|
+
reservations?: {
|
|
3501
|
+
/** @description Number of products reserved ad hoc. */
|
|
3502
|
+
adhoc: number;
|
|
3503
|
+
/** @description Number of products reserved for auctions. */
|
|
3504
|
+
auction: number;
|
|
3505
|
+
/** @description Number of products reserved for clients. */
|
|
3506
|
+
client: number;
|
|
3507
|
+
/** @description Number of products reserved for orders. */
|
|
3508
|
+
order: number;
|
|
3509
|
+
/** @description Number of products reserved for retail sales. */
|
|
3510
|
+
retail: number;
|
|
3511
|
+
/** @description Number of products reserved for wholesale sales. */
|
|
3512
|
+
wholesale: number;
|
|
3513
|
+
};
|
|
3514
|
+
}[];
|
|
3515
|
+
}[];
|
|
3516
|
+
/** @description Available stock quantities data. */
|
|
3517
|
+
dispositions: {
|
|
3518
|
+
/** @description Information on auction sites. */
|
|
3519
|
+
auctions: {
|
|
3520
|
+
/** @description Size identifier. */
|
|
3521
|
+
size_id: number;
|
|
3522
|
+
/** @description Size identifier */
|
|
3523
|
+
sizeId: string;
|
|
3524
|
+
/** @description Size name. */
|
|
3525
|
+
size_name: string;
|
|
3526
|
+
/** @description External system code. */
|
|
3527
|
+
product_sizecode: string;
|
|
3528
|
+
/** @description Number of products in delivery. */
|
|
3529
|
+
quantity: number;
|
|
3530
|
+
}[];
|
|
3531
|
+
sales: {
|
|
3532
|
+
/** @description Size identifier. */
|
|
3533
|
+
size_id: number;
|
|
3534
|
+
/** @description Size identifier */
|
|
3535
|
+
sizeId: string;
|
|
3536
|
+
/** @description Size name. */
|
|
3537
|
+
size_name: string;
|
|
3538
|
+
/** @description External system code. */
|
|
3539
|
+
product_sizecode: string;
|
|
3540
|
+
/** @description Available stock quantity of product from supplier stock. */
|
|
3541
|
+
outsidestock: number;
|
|
3542
|
+
/** @description Available stock quantity of product from own stock. */
|
|
3543
|
+
ownstock: number;
|
|
3544
|
+
/** @description Available stock quantity of product from all stocks. */
|
|
3545
|
+
allstocks: number;
|
|
3546
|
+
/** @description Available product quantity in own stock from before 1 day . */
|
|
3547
|
+
disposition1d?: number;
|
|
3548
|
+
/** @description Available product quantity in own stock from before 2 Days. */
|
|
3549
|
+
disposition2d?: number;
|
|
3550
|
+
/** @description Available product quantity in own stock from before 3 Days. */
|
|
3551
|
+
disposition3d?: number;
|
|
3552
|
+
/** @description Available product quantity in own stock from before 4 Days. */
|
|
3553
|
+
disposition4d?: number;
|
|
3554
|
+
/** @description Available product quantity in own stock from before 5 Days. */
|
|
3555
|
+
disposition5d?: number;
|
|
3556
|
+
/** @description Available product quantity in own stock from before 6 Days. */
|
|
3557
|
+
disposition6d?: number;
|
|
3558
|
+
/** @description Available product quantity in own stock from before 7 Days. */
|
|
3559
|
+
disposition7d?: number;
|
|
3560
|
+
/** @description Available product quantity in own stock from before 1 week. */
|
|
3561
|
+
disposition1w?: number;
|
|
3562
|
+
/** @description Available product quantity in own stock from before 2 weeks. */
|
|
3563
|
+
disposition2w?: number;
|
|
3564
|
+
/** @description Available product quantity in own stock from before 3 weeks. */
|
|
3565
|
+
disposition3w?: number;
|
|
3566
|
+
/** @description Available product quantity in own stock from before 4 weeks. */
|
|
3567
|
+
disposition4w?: number;
|
|
3568
|
+
}[];
|
|
3569
|
+
};
|
|
3570
|
+
/** @description Delivery data. */
|
|
3571
|
+
deliveries: {
|
|
3572
|
+
/** @description Size identifier. */
|
|
3573
|
+
size_id: string;
|
|
3574
|
+
/** @description Size name. */
|
|
3575
|
+
size_name: string;
|
|
3576
|
+
/** @description Number of products in delivery. */
|
|
3577
|
+
quantity: number;
|
|
3578
|
+
}[];
|
|
3579
|
+
/** @description Data of number of products added to GRN. */
|
|
3580
|
+
goods_received_notes: {
|
|
3581
|
+
/** @description Size identifier. */
|
|
3582
|
+
size_id: string;
|
|
3583
|
+
/** @description Size name. */
|
|
3584
|
+
size_name: string;
|
|
3585
|
+
/** @description Number of products in delivery. */
|
|
3586
|
+
quantity: number;
|
|
3587
|
+
}[];
|
|
3588
|
+
stocks_locations: {
|
|
3589
|
+
/** @description Stock ID. */
|
|
3590
|
+
stock_id: number;
|
|
3591
|
+
/** @description List of sizes */
|
|
3592
|
+
sizes: {
|
|
3593
|
+
/** @description Size identifier. */
|
|
3594
|
+
size_id: string;
|
|
3595
|
+
/** @description Warehouse location ID. */
|
|
3596
|
+
location_id: number;
|
|
3597
|
+
/** @description Warehouse location full path. */
|
|
3598
|
+
location_text_id: string;
|
|
3599
|
+
/** @description Storage location code */
|
|
3600
|
+
location_code: string;
|
|
3601
|
+
/** @description Additional locations. */
|
|
3602
|
+
additionalLocations?: {
|
|
3603
|
+
/** @description Warehouse location ID. */
|
|
3604
|
+
additionalLocationId: number;
|
|
3605
|
+
/** @description Warehouse location full path. */
|
|
3606
|
+
additionalLocationTextId: string;
|
|
3607
|
+
/** @description Storage location code */
|
|
3608
|
+
additionalLocationCode: string;
|
|
3609
|
+
}[];
|
|
3610
|
+
}[];
|
|
3611
|
+
}[];
|
|
3612
|
+
};
|
|
3613
|
+
}[];
|
|
3614
|
+
/** @description Flag marking errors in the result. */
|
|
3615
|
+
is_errors: boolean;
|
|
3616
|
+
errors?: FaultCodeString;
|
|
3617
|
+
};
|
|
3618
|
+
|
|
3619
|
+
/** @version v6.1 Typechecked 2025-08-06 */
|
|
3620
|
+
export type GetResponsibilityEntitiesResponse = {
|
|
3621
|
+
results: {
|
|
3622
|
+
/** @description Identificator of the entity. */
|
|
3623
|
+
id: number;
|
|
3624
|
+
/** @description Short name/code. */
|
|
3625
|
+
code: string;
|
|
3626
|
+
/** @description Full name. */
|
|
3627
|
+
name: string;
|
|
3628
|
+
/** @description E-mail address. */
|
|
3629
|
+
mail: string;
|
|
3630
|
+
/** @description Street. */
|
|
3631
|
+
street: string;
|
|
3632
|
+
/** @description Building number. */
|
|
3633
|
+
number: string | null;
|
|
3634
|
+
/** @description Apartment number. */
|
|
3635
|
+
subnumber: string | null;
|
|
3636
|
+
/** @description Zipcode. */
|
|
3637
|
+
zipcode: string;
|
|
3638
|
+
/** @description City. */
|
|
3639
|
+
city: string;
|
|
3640
|
+
/** @description 2-letter ISO country code. */
|
|
3641
|
+
country: string;
|
|
3642
|
+
/** @description Phone number. */
|
|
3643
|
+
phone: string | null;
|
|
3644
|
+
/** @description Additional description. */
|
|
3645
|
+
description: string | null;
|
|
3646
|
+
/** @description URL to contact page. */
|
|
3647
|
+
url: string | null;
|
|
3648
|
+
}[];
|
|
3649
|
+
pagination: PagedResponse;
|
|
3650
|
+
};
|
|
3651
|
+
|
|
3652
|
+
/** @version v6.1 Typechecked 2025-08-06 */
|
|
3653
|
+
export type GetSizesResponse = {
|
|
3654
|
+
/** @description Date of last modification (YYYY-MM-DD HH-MM-SS). */
|
|
3655
|
+
last_changed_time: string;
|
|
3656
|
+
size_groups: {
|
|
3657
|
+
/** @description Size group ID. */
|
|
3658
|
+
group_id: number;
|
|
3659
|
+
/** @description Size group name. */
|
|
3660
|
+
group_name: string;
|
|
3661
|
+
/** @description List of sizes which belong to the group. */
|
|
3662
|
+
sizes: {
|
|
3663
|
+
/** @description Size identifier. */
|
|
3664
|
+
size_id: string;
|
|
3665
|
+
/** @description Size name. */
|
|
3666
|
+
size_name: string;
|
|
3667
|
+
lang_data: {
|
|
3668
|
+
/** @description Language code. Codes are compliant with ISO-639-3 standard. */
|
|
3669
|
+
lang_id: string;
|
|
3670
|
+
/** @description Size name in selected language. */
|
|
3671
|
+
name: string;
|
|
3672
|
+
}[];
|
|
3673
|
+
}[];
|
|
3674
|
+
}[];
|
|
3675
|
+
};
|
|
3676
|
+
|
|
3677
|
+
/** @version v6.1 Typechecked 2025-08-06 */
|
|
3678
|
+
export type GetCouriersPickupPointsResponse = {
|
|
3679
|
+
/** @description Parameters concerning returned results */
|
|
3680
|
+
result: {
|
|
3681
|
+
/** @description Collection point ID. */
|
|
3682
|
+
pickupPointId: number;
|
|
3683
|
+
/** @description external system code. */
|
|
3684
|
+
pickupPointExternalId: string;
|
|
3685
|
+
/** @description Courier ID. */
|
|
3686
|
+
courierId: number;
|
|
3687
|
+
/** @description collection point details. */
|
|
3688
|
+
descriptions: {
|
|
3689
|
+
/** @description Language ID (code in ISO 639-2). */
|
|
3690
|
+
languageId: string;
|
|
3691
|
+
/** @description Name of the pickup point. */
|
|
3692
|
+
name: string;
|
|
3693
|
+
/** @description collection point description . */
|
|
3694
|
+
description: string;
|
|
3695
|
+
}[];
|
|
3696
|
+
/** @description Accepted payment types. */
|
|
3697
|
+
paymentForms: ("cash" | "card")[];
|
|
3698
|
+
/** @description Collection point activity. Available values: available, outOfService . */
|
|
3699
|
+
serviceStatus: "out_of_service" | "available";
|
|
3700
|
+
/** @description Pickup point address. */
|
|
3701
|
+
address: {
|
|
3702
|
+
/** @description Address. */
|
|
3703
|
+
street: string;
|
|
3704
|
+
/** @description ZIP / Post code. */
|
|
3705
|
+
zipCode: string;
|
|
3706
|
+
/** @description Town / City. */
|
|
3707
|
+
city: string;
|
|
3708
|
+
/** @description Administrative region (code in ISO 3166-2). */
|
|
3709
|
+
provinceCode?: string;
|
|
3710
|
+
/** @description Region name. */
|
|
3711
|
+
provinceName?: string;
|
|
3712
|
+
};
|
|
3713
|
+
/** @description Geographic coordinates. */
|
|
3714
|
+
coordinates: {
|
|
3715
|
+
/** @description Longitude. */
|
|
3716
|
+
longitude: number;
|
|
3717
|
+
/** @description Latitude. */
|
|
3718
|
+
latitude: number;
|
|
3719
|
+
};
|
|
3720
|
+
/** @description Personal collection point work hours. */
|
|
3721
|
+
operatingDays: {
|
|
3722
|
+
/** @description Days of the week designation.Day number: 1- Monday, 7 - Sunday. */
|
|
3723
|
+
weekday: number;
|
|
3724
|
+
/** @description collection point opening hours (HH:MM). */
|
|
3725
|
+
opening: string;
|
|
3726
|
+
/** @description collection point closing time (HH:MM). */
|
|
3727
|
+
closing: string;
|
|
3728
|
+
/** @description #!trybPracyPunktuDostepneWartosciOpenInOtwartyOdDoClosedZamkniety24hCzynnyCalaDobe!#. */
|
|
3729
|
+
operatingMode: "open_in" | "closed" | "24h";
|
|
3730
|
+
}[];
|
|
3731
|
+
}[];
|
|
3732
|
+
} & PagedResponse;
|
|
3733
|
+
|
|
3734
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3735
|
+
export type GetClientsDeliveryAddressResponse = {
|
|
3736
|
+
/** @description Object contains detailed information on result of operation. */
|
|
3737
|
+
results: {
|
|
3738
|
+
/** @description External system code. */
|
|
3739
|
+
clientCodeExternal?: string;
|
|
3740
|
+
/** @description Unique client's number. */
|
|
3741
|
+
clientId: number;
|
|
3742
|
+
/** @description Customer's login. */
|
|
3743
|
+
clientLogin?: string;
|
|
3744
|
+
/** @description Delivery address. */
|
|
3745
|
+
clientDeliveryAddresses: {
|
|
3746
|
+
/** @description Delivery address ID. */
|
|
3747
|
+
clientDeliveryAddressId: string;
|
|
3748
|
+
/** @description Recipient's first name. */
|
|
3749
|
+
clientDeliveryAddressFirstName: string;
|
|
3750
|
+
/** @description Recipient's last name. */
|
|
3751
|
+
clientDeliveryAddressLastName: string;
|
|
3752
|
+
/** @description Additional information. */
|
|
3753
|
+
clientDeliveryAddressAdditional: string;
|
|
3754
|
+
/** @description Cell phone. */
|
|
3755
|
+
clientDeliveryAddressPhone1: string;
|
|
3756
|
+
/** @description Recipient's city. */
|
|
3757
|
+
clientDeliveryAddressCity: string;
|
|
3758
|
+
/** @description Recipient street and number. */
|
|
3759
|
+
clientDeliveryAddressStreet: string;
|
|
3760
|
+
/** @description Administrative region code. */
|
|
3761
|
+
clientDeliveryAddressRegionId: string;
|
|
3762
|
+
/** @description Administrative region code. */
|
|
3763
|
+
clientDeliveryAddressProvinceId: string;
|
|
3764
|
+
/** @description Recipient's postal code. */
|
|
3765
|
+
clientDeliveryAddressZipCode: string;
|
|
3766
|
+
/** @description Recipient's country. */
|
|
3767
|
+
clientDeliveryAddressCountry: string;
|
|
3768
|
+
}[];
|
|
3769
|
+
error: FaultCodeString;
|
|
3770
|
+
}[];
|
|
3771
|
+
};
|
|
3772
|
+
|
|
3773
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3774
|
+
export type GetClientsPayerAddressResponse = {
|
|
3775
|
+
payerAddressesResults: {
|
|
3776
|
+
/** @description Buyer's address id. */
|
|
3777
|
+
payerAddressId: number;
|
|
3778
|
+
/** @description Buyer's first name. */
|
|
3779
|
+
payerAddressFirstName: string;
|
|
3780
|
+
/** @description Buyer's last name. */
|
|
3781
|
+
payerAddressLastName: string;
|
|
3782
|
+
/** @description Company name. */
|
|
3783
|
+
payerAddressFirm: string;
|
|
3784
|
+
/** @description Customer VAT ID. */
|
|
3785
|
+
payerAddressNip: string;
|
|
3786
|
+
/** @description Buyer's telephone number. */
|
|
3787
|
+
payerAddressPhone: string;
|
|
3788
|
+
/** @description Buyer's street name and house number. */
|
|
3789
|
+
payerAddressStreet: string;
|
|
3790
|
+
/** @description Buyer's postal code. */
|
|
3791
|
+
payerAddressZipCode: string;
|
|
3792
|
+
/** @description Buyer's city. */
|
|
3793
|
+
payerAddressCity: string;
|
|
3794
|
+
/** @description Buyer's country. */
|
|
3795
|
+
payerAddressCountry: string;
|
|
3796
|
+
/** @description Country code in the ISO 3166-1 A2 standard. */
|
|
3797
|
+
payerAddressCountryId: string;
|
|
3798
|
+
}[];
|
|
3799
|
+
} & PagedResponse;
|
|
3800
|
+
|
|
3801
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3802
|
+
export type GetProductsAuctionsResponse = {
|
|
3803
|
+
/** @description Object contains detailed information on result of operation. */
|
|
3804
|
+
results: {
|
|
3805
|
+
/** @description Products list. */
|
|
3806
|
+
products: {
|
|
3807
|
+
[auction: string]: {
|
|
3808
|
+
productId: {
|
|
3809
|
+
/** */
|
|
3810
|
+
identType: "id" | "index" | "codeExtern" | "codeProducer";
|
|
3811
|
+
/** @description ID value. */
|
|
3812
|
+
identValue: string;
|
|
3813
|
+
};
|
|
3814
|
+
/** @description External listings - orders table. */
|
|
3815
|
+
auctions: {
|
|
3816
|
+
[index: string]: {
|
|
3817
|
+
/** @description Auction site page ID */
|
|
3818
|
+
auctionSiteId: string;
|
|
3819
|
+
/** @description Auction number on the auction site */
|
|
3820
|
+
auctionId: string;
|
|
3821
|
+
}
|
|
3822
|
+
} | [];
|
|
3823
|
+
auctionCategories: {
|
|
3824
|
+
[index: string]: {
|
|
3825
|
+
/** @description Auction site page ID */
|
|
3826
|
+
auctionSiteId: string;
|
|
3827
|
+
/** @description Numeric ID of the category in the auction site */
|
|
3828
|
+
auctionCategoryId: string;
|
|
3829
|
+
/** @description Category path */
|
|
3830
|
+
auctionCategoryPath: string;
|
|
3831
|
+
}
|
|
3832
|
+
} | [];
|
|
3833
|
+
}
|
|
3834
|
+
} | [];
|
|
3835
|
+
} & PagedResponse;
|
|
3836
|
+
};
|
|
3837
|
+
|
|
3838
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3839
|
+
export type GetProductsBrandsResponse = {
|
|
3840
|
+
/** @description Element containing a list of found results on a given page. */
|
|
3841
|
+
producers: {
|
|
3842
|
+
/** @description Brand ID. */
|
|
3843
|
+
id: number;
|
|
3844
|
+
/** @description Brand name. */
|
|
3845
|
+
name: string;
|
|
3846
|
+
/** @description Deliverer ID (deprecated). */
|
|
3847
|
+
deliverer_id: number;
|
|
3848
|
+
/** @description Supplier name (deprecated). */
|
|
3849
|
+
deliverer_name: string;
|
|
3850
|
+
/** @description Supplier login (deprecated). */
|
|
3851
|
+
deliverer_login: string;
|
|
3852
|
+
/** @description Average delivery time in days (deprecated). */
|
|
3853
|
+
delivery_time_days: number;
|
|
3854
|
+
/** @description Currency. */
|
|
3855
|
+
currency: string;
|
|
3856
|
+
lang_data: {
|
|
3857
|
+
/** @description Language code. Codes are compliant with ISO-639-3 standard. */
|
|
3858
|
+
lang_id: string;
|
|
3859
|
+
/** @description Description. */
|
|
3860
|
+
text: string;
|
|
3861
|
+
productsListImagesConfiguration: {
|
|
3862
|
+
/** @description Type of graphics */
|
|
3863
|
+
graphicType?: "img" | "img_rwd";
|
|
3864
|
+
/** @description Image (one size for computers, tablets and smartphones, not recommended) */
|
|
3865
|
+
singleGraphic: string;
|
|
3866
|
+
/** @description #!GrafikaDlaEkranowKomputera#! */
|
|
3867
|
+
pcGraphic: string;
|
|
3868
|
+
/** @description Graphics for tablets */
|
|
3869
|
+
tabletGraphic: string;
|
|
3870
|
+
/** @description Graphics for smartphones */
|
|
3871
|
+
phoneGraphic: string;
|
|
3872
|
+
};
|
|
3873
|
+
/** @description Graphic displayed on product card */
|
|
3874
|
+
productCardImagesConfiguration: {
|
|
3875
|
+
/** @description Type of graphics */
|
|
3876
|
+
graphicType?: "img" | "img_rwd";
|
|
3877
|
+
/** @description Image (one size for computers, tablets and smartphones, not recommended) */
|
|
3878
|
+
singleGraphic: string;
|
|
3879
|
+
/** @description #!GrafikaDlaEkranowKomputera#! */
|
|
3880
|
+
pcGraphic: string;
|
|
3881
|
+
/** @description Graphics for tablets */
|
|
3882
|
+
tabletGraphic: string;
|
|
3883
|
+
/** @description Graphics for smartphones */
|
|
3884
|
+
phoneGraphic: string;
|
|
3885
|
+
};
|
|
3886
|
+
}[];
|
|
3887
|
+
}[];
|
|
3888
|
+
} & PagedSnakecaseResponse;
|
|
3889
|
+
|
|
3890
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3891
|
+
export type GetProductsDescriptionsResponse = {
|
|
3892
|
+
/** @description Object contains detailed information on result of operation. */
|
|
3893
|
+
results: {
|
|
3894
|
+
/** @description Stock keeping unit. */
|
|
3895
|
+
productIdent: {
|
|
3896
|
+
/** @description Identifier type. */
|
|
3897
|
+
productIdentType: "id" | "index" | "codeExtern" | "codeProducer";
|
|
3898
|
+
/** @description ID value. */
|
|
3899
|
+
identValue: string;
|
|
3900
|
+
/** @description Shop Id */
|
|
3901
|
+
shopId?: number;
|
|
3902
|
+
};
|
|
3903
|
+
/** @description Array of language-dependent elements. */
|
|
3904
|
+
productDescriptionsLangData: {
|
|
3905
|
+
/** @description Language ID */
|
|
3906
|
+
langId: string;
|
|
3907
|
+
/** @description Product name. */
|
|
3908
|
+
productName: string;
|
|
3909
|
+
/** @description Product name for auction service. */
|
|
3910
|
+
productAuctionName: string;
|
|
3911
|
+
/** @description Product name on price comparison sites */
|
|
3912
|
+
productPriceComparerName: string;
|
|
3913
|
+
/** @description Short product description. */
|
|
3914
|
+
productDescription: string;
|
|
3915
|
+
/** @description Long product description. */
|
|
3916
|
+
productLongDescription: string;
|
|
3917
|
+
productDescriptionSections: {
|
|
3918
|
+
descriptionSections: {
|
|
3919
|
+
[section: string]: {
|
|
3920
|
+
/** @enum {string} */
|
|
3921
|
+
type: "text" | "photo" | "video" | "html";
|
|
3922
|
+
/** @description HTML content depending on the type */
|
|
3923
|
+
content: string;
|
|
3924
|
+
};
|
|
3925
|
+
}[];
|
|
3926
|
+
}
|
|
3927
|
+
/** @description DEPRECATED. This parameter is deprecated. Long product description for external listings. */
|
|
3928
|
+
productAuctionLongDescription: string;
|
|
3929
|
+
/** @description Product meta title. */
|
|
3930
|
+
productMetaTitle: string;
|
|
3931
|
+
/** @description Product meta description. */
|
|
3932
|
+
productMetaDescription: string;
|
|
3933
|
+
/** @description Product meta keywords. */
|
|
3934
|
+
productMetaKeywords: string;
|
|
3935
|
+
}[];
|
|
3936
|
+
/** @description Product data for auction services */
|
|
3937
|
+
productAuctionDescriptionsData?: {
|
|
3938
|
+
/** @description Auction system ID */
|
|
3939
|
+
productAuctionId: number;
|
|
3940
|
+
/** @description Auction site ID */
|
|
3941
|
+
productAuctionSiteId: number;
|
|
3942
|
+
/** @description Product name for auction service. */
|
|
3943
|
+
productAuctionName: string;
|
|
3944
|
+
/** @description Subtitle for auction service */
|
|
3945
|
+
productAuctionAdditionalName: string;
|
|
3946
|
+
/** @description Product description for marketplaces */
|
|
3947
|
+
productAuctionDescription: string;
|
|
3948
|
+
}[];
|
|
3949
|
+
/** @description Error information. */
|
|
3950
|
+
error?: FaultCodeString;
|
|
3951
|
+
}[];
|
|
3952
|
+
/** @description Information about whether any errors occurred. */
|
|
3953
|
+
errorsOccurred: boolean;
|
|
3954
|
+
};
|
|
3955
|
+
|
|
3956
|
+
/** @version v6.1 Typechecked 2025-08-02 */
|
|
3957
|
+
export type GetProductsOpinionsResponse = {
|
|
3958
|
+
/** @description Object contains detailed information on result of operation. */
|
|
3959
|
+
results: {
|
|
3960
|
+
/** @example 1 */
|
|
3961
|
+
id: number;
|
|
3962
|
+
/** @example content */
|
|
3963
|
+
content: string;
|
|
3964
|
+
/** @example createDate */
|
|
3965
|
+
createDate: string;
|
|
3966
|
+
/** */
|
|
3967
|
+
points: number;
|
|
3968
|
+
confirmed: boolean;
|
|
3969
|
+
/** @example rating */
|
|
3970
|
+
rating: string;
|
|
3971
|
+
/** @description Customer language ID. */
|
|
3972
|
+
language: string;
|
|
3973
|
+
/** @example host */
|
|
3974
|
+
host: string;
|
|
3975
|
+
/** @description Shop Id */
|
|
3976
|
+
shopId: number;
|
|
3977
|
+
/** @example 1 */
|
|
3978
|
+
scorePositive: number;
|
|
3979
|
+
/** @example 1 */
|
|
3980
|
+
scoreNegative: number;
|
|
3981
|
+
picture?: {
|
|
3982
|
+
large: {
|
|
3983
|
+
/** @example url */
|
|
3984
|
+
url: string;
|
|
3985
|
+
/** @example 1 */
|
|
3986
|
+
width: number;
|
|
3987
|
+
/** @example 1 */
|
|
3988
|
+
height: number;
|
|
3989
|
+
/** @example hash */
|
|
3990
|
+
hash: string;
|
|
3991
|
+
};
|
|
3992
|
+
small?: {
|
|
3993
|
+
/** @example url */
|
|
3994
|
+
url: string;
|
|
3995
|
+
/** @example 1 */
|
|
3996
|
+
width: number;
|
|
3997
|
+
/** @example 1 */
|
|
3998
|
+
height: number;
|
|
3999
|
+
/** @example hash */
|
|
4000
|
+
hash: string;
|
|
4001
|
+
};
|
|
4002
|
+
};
|
|
4003
|
+
/** @description Opinion writer's data */
|
|
4004
|
+
client?: {
|
|
4005
|
+
/** @description Customer's login. */
|
|
4006
|
+
login: string;
|
|
4007
|
+
/** @example 1 */
|
|
4008
|
+
id: number;
|
|
4009
|
+
};
|
|
4010
|
+
product: {
|
|
4011
|
+
/** @example 1 */
|
|
4012
|
+
id: number;
|
|
4013
|
+
};
|
|
4014
|
+
/** @description Reply to an opinion */
|
|
4015
|
+
answer: string;
|
|
4016
|
+
/** @description Date of reply to opinion in the YYYY-MM-DD HH:MM:SS format */
|
|
4017
|
+
answerDatetime: string;
|
|
4018
|
+
/** @description Opinion modification date */
|
|
4019
|
+
modificationDatetime: string;
|
|
4020
|
+
/** @description Opinion confirmed with purchase */
|
|
4021
|
+
confirmedByPurchase: boolean;
|
|
4022
|
+
}[];
|
|
4023
|
+
} & PagedResponse;
|
|
4024
|
+
|
|
4025
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4026
|
+
export type GetSnippetsResponse = {
|
|
4027
|
+
results: {
|
|
4028
|
+
/** @description Id of the code snippet. */
|
|
4029
|
+
id: number | null;
|
|
4030
|
+
/** @description The snippet name. */
|
|
4031
|
+
name: string;
|
|
4032
|
+
/** @description Whether the snippet is active. */
|
|
4033
|
+
active: "y" | "n";
|
|
4034
|
+
/** @description Snippet campaign id */
|
|
4035
|
+
campaign: number;
|
|
4036
|
+
dateBegin: {
|
|
4037
|
+
/** @description Whether date condition is active */
|
|
4038
|
+
defined: "y" | "n";
|
|
4039
|
+
/** Format: date
|
|
4040
|
+
* @description Date of snippet activation */
|
|
4041
|
+
date: string | null;
|
|
4042
|
+
} & {
|
|
4043
|
+
/** @description Automatic shutdown control */
|
|
4044
|
+
autoBlock: "y" | "n";
|
|
4045
|
+
};
|
|
4046
|
+
/** @description Filter to control snippet activation. */
|
|
4047
|
+
dateEnd: {
|
|
4048
|
+
/** @description Whether date condition is active */
|
|
4049
|
+
defined: "y" | "n";
|
|
4050
|
+
/** Format: date
|
|
4051
|
+
* @description Date of snippet activation */
|
|
4052
|
+
date: string | null;
|
|
4053
|
+
};
|
|
4054
|
+
/** @description Code snippet type. */
|
|
4055
|
+
type: "html" | "javascript" | "cgi";
|
|
4056
|
+
/** @description Whether to load contents asynchronously via XHR request. */
|
|
4057
|
+
useAjax: "y" | "n";
|
|
4058
|
+
/** @description Url. */
|
|
4059
|
+
link: string;
|
|
4060
|
+
/** @description Content waiting time (timeout) in seconds. */
|
|
4061
|
+
timeout: number;
|
|
4062
|
+
/** @description The place where the code snippet is loaded. */
|
|
4063
|
+
zone: "head" | "bodyBegin" | "bodyEnd";
|
|
4064
|
+
/** @description The order in which the code snippet will be displayed. */
|
|
4065
|
+
order: number;
|
|
4066
|
+
/** @description Snippet content for each language. */
|
|
4067
|
+
body: {
|
|
4068
|
+
/** @description Language code. */
|
|
4069
|
+
lang: string;
|
|
4070
|
+
/** @example Hello world */
|
|
4071
|
+
body: string;
|
|
4072
|
+
}[];
|
|
4073
|
+
display: {
|
|
4074
|
+
/** @description Type of customers to whom to display the snippet */
|
|
4075
|
+
clientType: "all" | "unregistered" | "registered" | "retailer" | "wholesaler";
|
|
4076
|
+
/** @description Whether to display only for newsletter visitors. */
|
|
4077
|
+
newsletter: "y" | "n" | "all";
|
|
4078
|
+
/** @description Whether to display the code snippet only for customers who have placed an order */
|
|
4079
|
+
hasOrders: "y" | "n" | "all";
|
|
4080
|
+
/** @description Display only after entering rebate code */
|
|
4081
|
+
useRebateCode: "y" | "n" | "all";
|
|
4082
|
+
} & {
|
|
4083
|
+
/** @description Display on desktop screens */
|
|
4084
|
+
screen: "y" | "n";
|
|
4085
|
+
/** @description Display on mobile tablets */
|
|
4086
|
+
tablet: "y" | "n";
|
|
4087
|
+
/** @description Display on mobile phones */
|
|
4088
|
+
phone: "y" | "n";
|
|
4089
|
+
};
|
|
4090
|
+
pages: {
|
|
4091
|
+
/** @description Whether to display to all sites. */
|
|
4092
|
+
all: "y" | "n";
|
|
4093
|
+
/** @description List of selected pages where snippet shows (works for all=n mode). If passed, the url should be omitted. */
|
|
4094
|
+
pages?: ("home" | "basket" | "checkout_payment_delivery" | "checkout_confirmation" | "new_order_placement" | "order_details" | "navigation" | "product_details" | "search_results" | "after_order_place" | "mailing_subscribe" | "payment_success" | "payment_error" | "payment_pending" | "other_pages")[];
|
|
4095
|
+
/** @description List of selected url (works for all=n mode) If passed, pages should be omitted. */
|
|
4096
|
+
url?: string[];
|
|
4097
|
+
};
|
|
4098
|
+
/** @description Snippet entry source filter. */
|
|
4099
|
+
sources?: {
|
|
4100
|
+
direct: {
|
|
4101
|
+
/** @description Whether source filter is active */
|
|
4102
|
+
active: "y" | "n";
|
|
4103
|
+
/** @description Id of service of given source */
|
|
4104
|
+
id: number | null;
|
|
4105
|
+
} | null;
|
|
4106
|
+
search: {
|
|
4107
|
+
/** @description Whether source filter is active */
|
|
4108
|
+
active: "y" | "n";
|
|
4109
|
+
/** @description Id of service of given source */
|
|
4110
|
+
id: number | null;
|
|
4111
|
+
} | null;
|
|
4112
|
+
advert: {
|
|
4113
|
+
/** @description Whether source filter is active */
|
|
4114
|
+
active: "y" | "n";
|
|
4115
|
+
/** @description Id of service of given source */
|
|
4116
|
+
id: number | null;
|
|
4117
|
+
} | null;
|
|
4118
|
+
priceComparers: {
|
|
4119
|
+
/** @description Whether source filter is active */
|
|
4120
|
+
active: "y" | "n";
|
|
4121
|
+
/** @description Id of service of given source */
|
|
4122
|
+
id: number | null;
|
|
4123
|
+
} | null;
|
|
4124
|
+
affiliate: {
|
|
4125
|
+
/** @description Whether source filter is active */
|
|
4126
|
+
active: "y" | "n";
|
|
4127
|
+
/** @description Id of service of given source */
|
|
4128
|
+
id: number | null;
|
|
4129
|
+
} | null;
|
|
4130
|
+
cpa: {
|
|
4131
|
+
/** @description Whether source filter is active */
|
|
4132
|
+
active: "y" | "n";
|
|
4133
|
+
/** @description Id of service of given source */
|
|
4134
|
+
id: number | null;
|
|
4135
|
+
} | null;
|
|
4136
|
+
newsletter: {
|
|
4137
|
+
/** @description Whether source filter is active */
|
|
4138
|
+
active: "y" | "n";
|
|
4139
|
+
/** @description Id of service of given source */
|
|
4140
|
+
id: number | null;
|
|
4141
|
+
} | null;
|
|
4142
|
+
social: {
|
|
4143
|
+
/** @description Whether source filter is active */
|
|
4144
|
+
active: "y" | "n";
|
|
4145
|
+
/** @description Id of service of given source */
|
|
4146
|
+
id: number | null;
|
|
4147
|
+
} | null;
|
|
4148
|
+
page: {
|
|
4149
|
+
/** @description Whether source filter is active */
|
|
4150
|
+
active: "y" | "n";
|
|
4151
|
+
/** @description Id of service of given source */
|
|
4152
|
+
id: number | null;
|
|
4153
|
+
} | null;
|
|
4154
|
+
};
|
|
4155
|
+
/** @description Whether the snippet is marked as deleted. */
|
|
4156
|
+
readonly deleted: "y" | "n";
|
|
4157
|
+
/** @description The number of cookies associated with the snippet. */
|
|
4158
|
+
readonly cookiesCount: number;
|
|
4159
|
+
}[];
|
|
4160
|
+
pagination: PagedResponse;
|
|
4161
|
+
};
|
|
4162
|
+
|
|
4163
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4164
|
+
export type GetSystemUsersResponse = {
|
|
4165
|
+
/** @description List of panel users. */
|
|
4166
|
+
users: {
|
|
4167
|
+
/** @description Panel user login. */
|
|
4168
|
+
login: string;
|
|
4169
|
+
/** @description User name and surname. */
|
|
4170
|
+
name: string;
|
|
4171
|
+
/** @description User rights to modules. */
|
|
4172
|
+
rights: {
|
|
4173
|
+
/** @description Limited hours of access to panel: "y" - yes, "n" - no. */
|
|
4174
|
+
limited: string;
|
|
4175
|
+
/** @description Customers: "y" - yes, "n" - no. */
|
|
4176
|
+
clients: string;
|
|
4177
|
+
/** @description Orders: "y" - yes, "n" - no. */
|
|
4178
|
+
orders: string;
|
|
4179
|
+
/** @description Products: "y" - yes, "n" - no. */
|
|
4180
|
+
products: string;
|
|
4181
|
+
/** @description Moderator: "y" - yes, "n" - no. */
|
|
4182
|
+
moderator: string;
|
|
4183
|
+
/** @description POS sales: "y" - yes, "n" - no. */
|
|
4184
|
+
selling: string;
|
|
4185
|
+
/** @description Printing invoices in IdoSell POS: "y" - yes, "n" - no. */
|
|
4186
|
+
pos_invoice_printing: string;
|
|
4187
|
+
/** @description Financial statements: "y" - yes, "n" - no. */
|
|
4188
|
+
finances: string;
|
|
4189
|
+
/** @description Payment management: "y" - yes, "n" - no. */
|
|
4190
|
+
payments: string;
|
|
4191
|
+
/** @description Newsletter and customer database export: "y" - yes, "n" - no. */
|
|
4192
|
+
mailing: string;
|
|
4193
|
+
/** @description Marketing: "y" - yes, "n" - no. */
|
|
4194
|
+
integration: string;
|
|
4195
|
+
/** @description Admin: "y" - yes, "n" - no. */
|
|
4196
|
+
admin: string;
|
|
4197
|
+
/** @description Approval of outsourced work cost: "y" - yes, "n" - no. */
|
|
4198
|
+
iai_orders: string;
|
|
4199
|
+
/** @description Access rights to M0 supplier stock: "y" - yes, "n" - no. */
|
|
4200
|
+
outsource: string;
|
|
4201
|
+
/** @description Access rights to own stocks (bit mask). */
|
|
4202
|
+
stocks: number;
|
|
4203
|
+
/** @description List of warehouses with relevant user rights */
|
|
4204
|
+
stocks_list: {
|
|
4205
|
+
/** @description Stock ID. */
|
|
4206
|
+
stock_id: number;
|
|
4207
|
+
/** @description User privileges for a given warehouse. */
|
|
4208
|
+
stock_rights: boolean;
|
|
4209
|
+
}[];
|
|
4210
|
+
/** @description List of languages in which the user can translate the offer. */
|
|
4211
|
+
offer_translations: {
|
|
4212
|
+
/** @description Language ID. */
|
|
4213
|
+
language_id: string;
|
|
4214
|
+
/** @description User language privileges. */
|
|
4215
|
+
language_rights: boolean;
|
|
4216
|
+
}[];
|
|
4217
|
+
};
|
|
4218
|
+
/** @description Panel interface language. */
|
|
4219
|
+
panel_language: string;
|
|
4220
|
+
/** @description Format of dates, numbers and amounts. */
|
|
4221
|
+
locale: string;
|
|
4222
|
+
}[];
|
|
4223
|
+
};
|
|
4224
|
+
|
|
4225
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4226
|
+
export type GetWmsSuppliersResponse = {
|
|
4227
|
+
/** @description List of product suppliers */
|
|
4228
|
+
suppliers: {
|
|
4229
|
+
/** @description Id */
|
|
4230
|
+
id: number;
|
|
4231
|
+
/** @description Name. */
|
|
4232
|
+
name: string;
|
|
4233
|
+
/** @description Quantities of products */
|
|
4234
|
+
productsCount: null | number;
|
|
4235
|
+
/** @description E-mail address */
|
|
4236
|
+
email: string;
|
|
4237
|
+
/** @description Phone number. */
|
|
4238
|
+
phone: string;
|
|
4239
|
+
/** @description Fax */
|
|
4240
|
+
fax: string;
|
|
4241
|
+
/** @description Address. */
|
|
4242
|
+
street: string;
|
|
4243
|
+
/** @description ZIP / Post code. */
|
|
4244
|
+
zipCode: string;
|
|
4245
|
+
/** @description Town / City. */
|
|
4246
|
+
city: string;
|
|
4247
|
+
/** @description Region ID */
|
|
4248
|
+
country: number;
|
|
4249
|
+
/** @description VAT no. */
|
|
4250
|
+
taxCode: string;
|
|
4251
|
+
/** @description Average delivery time */
|
|
4252
|
+
averageDeliveryTime: {
|
|
4253
|
+
/** @example 1 */
|
|
4254
|
+
value: number;
|
|
4255
|
+
/** @example unit */
|
|
4256
|
+
unit: string;
|
|
4257
|
+
};
|
|
4258
|
+
/** @description Description */
|
|
4259
|
+
description: string;
|
|
4260
|
+
/** @description Order preparation time for shipment */
|
|
4261
|
+
orderCompletionTime: {
|
|
4262
|
+
/** @example 1 */
|
|
4263
|
+
value: number;
|
|
4264
|
+
/** @example unit */
|
|
4265
|
+
unit: string;
|
|
4266
|
+
};
|
|
4267
|
+
/** @description Supplier working hours */
|
|
4268
|
+
workDays: {
|
|
4269
|
+
/** @description day */
|
|
4270
|
+
day: number;
|
|
4271
|
+
/** @description Type */
|
|
4272
|
+
type: string;
|
|
4273
|
+
/** @description from */
|
|
4274
|
+
from: null | string;
|
|
4275
|
+
/** @description to */
|
|
4276
|
+
to: null | string;
|
|
4277
|
+
}[];
|
|
4278
|
+
}[];
|
|
4279
|
+
} & PagedResponse;
|
|
4280
|
+
|
|
4281
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4282
|
+
export type GetProductsCodeExistenceResponse = {
|
|
4283
|
+
results: {
|
|
4284
|
+
/** @description Products list. */
|
|
4285
|
+
products: {
|
|
4286
|
+
/** @description Identifier of the product being checked */
|
|
4287
|
+
requestProductId: string;
|
|
4288
|
+
/** @description Type of identifier of the product being checked. */
|
|
4289
|
+
requestProductIdentType: "id" | "index" | "codeExtern" | "codeProducer" | "codeDeliverer";
|
|
4290
|
+
/** @description Supplier ID. */
|
|
4291
|
+
delivererId?: string;
|
|
4292
|
+
/** @description IdoSell ID of the searched product */
|
|
4293
|
+
foundProductId?: string;
|
|
4294
|
+
/** @description The identifier of the retrieved size, if the passed product identifier allowed such identification. */
|
|
4295
|
+
foundSizeId?: string;
|
|
4296
|
+
}[];
|
|
4297
|
+
};
|
|
4298
|
+
};
|
|
4299
|
+
|
|
4300
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4301
|
+
export type GetProductsIdBySizecodeResponse = {
|
|
4302
|
+
/** @description Object contains detailed information on result of operation. */
|
|
4303
|
+
results: {
|
|
4304
|
+
/** @description Searching code. */
|
|
4305
|
+
productSizeCode: string;
|
|
4306
|
+
/** @description Product IAI code */
|
|
4307
|
+
productId?: number;
|
|
4308
|
+
/** @description Size identifier */
|
|
4309
|
+
sizeId?: string;
|
|
4310
|
+
/** @description Size name */
|
|
4311
|
+
sizePanelName?: string;
|
|
4312
|
+
/** @description Does the product with the specified code exist. */
|
|
4313
|
+
productWithIndicatedCodeExists: boolean;
|
|
4314
|
+
/** @description Element determines whether product is deleted */
|
|
4315
|
+
productIsDeleted: boolean;
|
|
4316
|
+
}[];
|
|
4317
|
+
};
|
|
4318
|
+
|
|
4319
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4320
|
+
export type GetProductsOmnibusPricesResponse = {
|
|
4321
|
+
/** @description Products list. */
|
|
4322
|
+
products: {
|
|
4323
|
+
[productId: string]: {
|
|
4324
|
+
shops: {
|
|
4325
|
+
[shopId: string]: {
|
|
4326
|
+
/** @description Shop Id */
|
|
4327
|
+
shop_id: number;
|
|
4328
|
+
/** @description Lowest retail price before active promotion (gross). */
|
|
4329
|
+
omnibusPriceRetail: number;
|
|
4330
|
+
/** @description Lowest wholesale price before active promotion (gross). */
|
|
4331
|
+
omnibusPriceWholesale: number;
|
|
4332
|
+
/** @description How to manage the lowest price before promotion. */
|
|
4333
|
+
omnibusPriceManagement: "automatic" | "manual";
|
|
4334
|
+
/** @description List of sizes */
|
|
4335
|
+
sizes: {
|
|
4336
|
+
[sizeId: string]: {
|
|
4337
|
+
/** @description Identifier type. */
|
|
4338
|
+
ident: {
|
|
4339
|
+
/** */
|
|
4340
|
+
type: "id" | "index" | "codeExtern" | "codeProducer";
|
|
4341
|
+
/** @description Value. */
|
|
4342
|
+
value: string;
|
|
4343
|
+
};
|
|
4344
|
+
/** @description Lowest retail price before active promotion (gross). */
|
|
4345
|
+
omnibusPriceRetail: number;
|
|
4346
|
+
/** @description Lowest wholesale price before active promotion (gross). */
|
|
4347
|
+
omnibusPriceWholesale: number;
|
|
4348
|
+
/** @description How to manage the lowest price before promotion. */
|
|
4349
|
+
omnibusPriceManagement: "automatic" | "manual"
|
|
4350
|
+
} | []
|
|
4351
|
+
}
|
|
4352
|
+
} | []
|
|
4353
|
+
};
|
|
4354
|
+
/** @description Error information. */
|
|
4355
|
+
error?: FaultCodeString
|
|
4356
|
+
} | []
|
|
4357
|
+
};
|
|
4358
|
+
};
|
|
4359
|
+
|
|
4360
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4361
|
+
export type GetProductsSizesResponse = {
|
|
4362
|
+
/** @description Object contains detailed information on result of operation. */
|
|
4363
|
+
results: {
|
|
4364
|
+
[productId: string]: {
|
|
4365
|
+
/** @description Product IAI code */
|
|
4366
|
+
productId: number;
|
|
4367
|
+
/** @description List of sizes */
|
|
4368
|
+
sizesResult: {
|
|
4369
|
+
/** @description Size identifier */
|
|
4370
|
+
sizeId: string;
|
|
4371
|
+
/** @description Size name */
|
|
4372
|
+
sizePanelName: string;
|
|
4373
|
+
/** @description Producer code */
|
|
4374
|
+
productProducerCode: string;
|
|
4375
|
+
/** @description External product system code for size. */
|
|
4376
|
+
productSizeCodeExternal: string;
|
|
4377
|
+
/** @description Weight. */
|
|
4378
|
+
productWeight: number;
|
|
4379
|
+
/** @description Page list */
|
|
4380
|
+
sites?: {
|
|
4381
|
+
/** @description Page ID */
|
|
4382
|
+
siteId: number;
|
|
4383
|
+
/** @description Store name */
|
|
4384
|
+
siteName: string;
|
|
4385
|
+
/** @description Gross price */
|
|
4386
|
+
productRetailPrice: number;
|
|
4387
|
+
/** @description Wholesale price */
|
|
4388
|
+
productWholesalePrice: number;
|
|
4389
|
+
/** @description Minimal price */
|
|
4390
|
+
productMinimalPrice: number;
|
|
4391
|
+
/** @description Recommended retail price */
|
|
4392
|
+
productSuggestedPrice: number;
|
|
4393
|
+
}[];
|
|
4394
|
+
}[]
|
|
4395
|
+
} | []
|
|
4396
|
+
};
|
|
4397
|
+
/** @description Parameters concerning returned results */
|
|
4398
|
+
result: {
|
|
4399
|
+
/** @description Page with results number. Numeration starts from 0 */
|
|
4400
|
+
page: number;
|
|
4401
|
+
/** @description Number of results on page. Value from 1 to 100 */
|
|
4402
|
+
pageNumber: number;
|
|
4403
|
+
/** @description Number of pages of results found */
|
|
4404
|
+
pageAll: number;
|
|
4405
|
+
/** @description Number of all results found. */
|
|
4406
|
+
pageNumberAll: number;
|
|
4407
|
+
};
|
|
4408
|
+
};
|
|
4409
|
+
|
|
4410
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4411
|
+
export type GetProductsSKUbyBarcodeResponse = {
|
|
4412
|
+
/** @description Object contains detailed information on result of operation. */
|
|
4413
|
+
results: {
|
|
4414
|
+
/** @description One of the unique, indexed product codes (IAI code / External system code / Producer code) */
|
|
4415
|
+
foundByIndex: string;
|
|
4416
|
+
/** @description Products matching the indicated search criteria */
|
|
4417
|
+
productSkuList: {
|
|
4418
|
+
/** @description Product IAI code */
|
|
4419
|
+
productId: number;
|
|
4420
|
+
/** @description Product name. */
|
|
4421
|
+
productName: string;
|
|
4422
|
+
/** @description Size identifier */
|
|
4423
|
+
sizeId: string;
|
|
4424
|
+
/** @description Size name */
|
|
4425
|
+
sizeName: string;
|
|
4426
|
+
/** @description IAI code */
|
|
4427
|
+
codeIai: string;
|
|
4428
|
+
/** @description External product system code for size. */
|
|
4429
|
+
codeExternal: string;
|
|
4430
|
+
/** @description Producer code for size. */
|
|
4431
|
+
codeProducer: string;
|
|
4432
|
+
/** @description Weight */
|
|
4433
|
+
weight: number;
|
|
4434
|
+
/** @description Available stock quantities data */
|
|
4435
|
+
quantities: {
|
|
4436
|
+
/** @description Stock ID */
|
|
4437
|
+
stockId: number;
|
|
4438
|
+
/** @description Product stock quantity */
|
|
4439
|
+
quantity: number;
|
|
4440
|
+
/** @description Available stock quantity for order sales */
|
|
4441
|
+
disposition: number;
|
|
4442
|
+
}[];
|
|
4443
|
+
/** @description Warehouse locations */
|
|
4444
|
+
stockLocations: {
|
|
4445
|
+
/** @description Stock ID */
|
|
4446
|
+
stockId: number;
|
|
4447
|
+
/** @description Warehouse location ID */
|
|
4448
|
+
stockLocationId: number;
|
|
4449
|
+
/** @description Warehouse location full path */
|
|
4450
|
+
stockLocationTextId: string;
|
|
4451
|
+
/** @description Storage location code */
|
|
4452
|
+
stockLocationCode: string;
|
|
4453
|
+
/** @description Additional locations */
|
|
4454
|
+
stockAdditionalLocations: {
|
|
4455
|
+
/** @description Warehouse location ID */
|
|
4456
|
+
stockAdditionalLocationId: number;
|
|
4457
|
+
/** @description Warehouse location full path */
|
|
4458
|
+
stockAdditionalLocationTextId: string;
|
|
4459
|
+
/** @description Storage location code */
|
|
4460
|
+
stockAdditionalLocationCode: string;
|
|
4461
|
+
}[];
|
|
4462
|
+
}[];
|
|
4463
|
+
/** @description Sold at - for wholesalers */
|
|
4464
|
+
sellByWholesale: number;
|
|
4465
|
+
/** @description Sold at - for retailers */
|
|
4466
|
+
sellByRetail: number;
|
|
4467
|
+
/** @description Number of items in package data */
|
|
4468
|
+
inWrapper: number;
|
|
4469
|
+
/** @description Brand name */
|
|
4470
|
+
producerName: string;
|
|
4471
|
+
/** @description Product icon details. */
|
|
4472
|
+
productIcon: {
|
|
4473
|
+
/** @description Determines whether icon has been set. Available values: "y" - icon is set, "n" - icon is not set (default icon is visible). */
|
|
4474
|
+
productIconExists: string;
|
|
4475
|
+
/** @description URL to large icon graphic file */
|
|
4476
|
+
productIconLargeUrl: string;
|
|
4477
|
+
/** @example productIconLargeUrlSecond */
|
|
4478
|
+
productIconLargeUrlSecond?: string;
|
|
4479
|
+
/** */
|
|
4480
|
+
productIconLargeSizeSecond?: number;
|
|
4481
|
+
/** @description Width of large icon */
|
|
4482
|
+
productIconLargeWidth: number;
|
|
4483
|
+
/** @description Height of large icon */
|
|
4484
|
+
productIconLargeHeight: number;
|
|
4485
|
+
/** @description Large icon size */
|
|
4486
|
+
productIconLargeSize: number;
|
|
4487
|
+
/** @description URL to small icon graphic file */
|
|
4488
|
+
productIconSmallUrl: string;
|
|
4489
|
+
/** @example productIconSmallUrlSecond */
|
|
4490
|
+
productIconSmallUrlSecond?: string;
|
|
4491
|
+
/** */
|
|
4492
|
+
productIconSmallSizeSecond?: number;
|
|
4493
|
+
/** @description MD5 hash of large icon graphic file */
|
|
4494
|
+
productIconHash: string;
|
|
4495
|
+
};
|
|
4496
|
+
/** @description Value of VAT */
|
|
4497
|
+
productVat: number;
|
|
4498
|
+
/** @description Is product VAT free Allowed values "y" - yes, "n" - no. */
|
|
4499
|
+
productVatFree: string;
|
|
4500
|
+
/** @description Supplier name. */
|
|
4501
|
+
delivererName: string;
|
|
4502
|
+
/** @description Annotation. */
|
|
4503
|
+
productNote: string;
|
|
4504
|
+
/** @description Product type. Allowed values: "product_item" - Goods, "product_free" - Free product, "product_packaging" - packaging, "product_bundle" - set. "product_collection" - collection. "product_service" - service. "product_virtual" - virtual product. "product_configurable" - configurable product. */
|
|
4505
|
+
productType: string;
|
|
4506
|
+
/** @description Prices in shops */
|
|
4507
|
+
productPrices: {
|
|
4508
|
+
/** @description Shop Id */
|
|
4509
|
+
shopId: number;
|
|
4510
|
+
/** @description Store name. */
|
|
4511
|
+
shopName: string;
|
|
4512
|
+
/** @description Gross price */
|
|
4513
|
+
productRetailPrice: number;
|
|
4514
|
+
/** @description Wholesale price */
|
|
4515
|
+
productWholesalePrice: number;
|
|
4516
|
+
/** @description Product retail price in the base currency of the panel. */
|
|
4517
|
+
productRetailPriceInPanelBaseCurrency: number;
|
|
4518
|
+
/** @description Wholesale price of the product in the base currency of the panel. */
|
|
4519
|
+
productWholesalePriceInPanelBaseCurrency: number;
|
|
4520
|
+
/** @description Currency ID */
|
|
4521
|
+
currencyId: string;
|
|
4522
|
+
}[];
|
|
4523
|
+
/** @description Array of language-dependent elements. */
|
|
4524
|
+
productDescriptionsLangData: {
|
|
4525
|
+
/** @description Language ID */
|
|
4526
|
+
langId: string;
|
|
4527
|
+
/** @description Product name. */
|
|
4528
|
+
name: string;
|
|
4529
|
+
/** @description Short product description. */
|
|
4530
|
+
description: string;
|
|
4531
|
+
}[];
|
|
4532
|
+
/** @description Barcode for product manufacturer code in Code39 or EAN13 standard. */
|
|
4533
|
+
codeProducerBarcodes: {
|
|
4534
|
+
/** @description Barcode type. */
|
|
4535
|
+
barcodeType: string;
|
|
4536
|
+
/** @example value */
|
|
4537
|
+
value: string;
|
|
4538
|
+
}[];
|
|
4539
|
+
/** @description Barcode for the external code of the product in standard Code39 or EAN13. */
|
|
4540
|
+
codeExternalBarcodes: {
|
|
4541
|
+
/** @description Barcode type. */
|
|
4542
|
+
barcodeType: string;
|
|
4543
|
+
/** @example value */
|
|
4544
|
+
value: string;
|
|
4545
|
+
}[];
|
|
4546
|
+
/** @description Barcode for product Id in Code39 or EAN13 standard. */
|
|
4547
|
+
codeIaiBarcodes: {
|
|
4548
|
+
/** @description Barcode type. */
|
|
4549
|
+
barcodeType: string;
|
|
4550
|
+
/** @example value */
|
|
4551
|
+
value: string;
|
|
4552
|
+
}[];
|
|
4553
|
+
}[];
|
|
4554
|
+
}[];
|
|
4555
|
+
};
|
|
4556
|
+
|
|
4557
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4558
|
+
export type GetSystemUnitsResponse = {
|
|
4559
|
+
result: {
|
|
4560
|
+
units: {
|
|
4561
|
+
[id: string]: {
|
|
4562
|
+
/** @description #!IdentyfikatorJednostki!# */
|
|
4563
|
+
id?: number;
|
|
4564
|
+
/** @description Name in panel (limit of 30 characters) */
|
|
4565
|
+
nameInPanel?: string;
|
|
4566
|
+
/** @description Accuracy (number of places after comma) */
|
|
4567
|
+
precisionUnit?: number;
|
|
4568
|
+
/** @description Visibility */
|
|
4569
|
+
visible: "y" | "n";
|
|
4570
|
+
descriptions: {
|
|
4571
|
+
[language: string]: {
|
|
4572
|
+
/** @description ISO-639-3 Language */
|
|
4573
|
+
language: string;
|
|
4574
|
+
/** @description Name (singular) (limit of 30 characters) */
|
|
4575
|
+
nameSingular: string;
|
|
4576
|
+
/** @description Name (plural) (limit of 30 characters) */
|
|
4577
|
+
namePlural: string;
|
|
4578
|
+
/** @description Name (by fractions) (limit of 30 characters) */
|
|
4579
|
+
nameFractions: string
|
|
4580
|
+
} | []
|
|
4581
|
+
}
|
|
4582
|
+
} | []
|
|
4583
|
+
};
|
|
4584
|
+
};
|
|
4585
|
+
};
|
|
4586
|
+
|
|
4587
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4588
|
+
export type GetProductsReservationsResponse = {
|
|
4589
|
+
/** @description Object contains detailed information on result of operation. */
|
|
4590
|
+
results: {
|
|
4591
|
+
/** @description Products list. */
|
|
4592
|
+
products: ({
|
|
4593
|
+
/** @description ID value. */
|
|
4594
|
+
identValue: string;
|
|
4595
|
+
/** @description An array of product reservations */
|
|
4596
|
+
reservations: {
|
|
4597
|
+
/** @description Stock ID */
|
|
4598
|
+
stockId: number;
|
|
4599
|
+
/** @description Order serial number. */
|
|
4600
|
+
orderSerialNumber: number;
|
|
4601
|
+
/** @description Number of reserved products */
|
|
4602
|
+
quantity: number;
|
|
4603
|
+
/** @description Reservation end date */
|
|
4604
|
+
endTime: string;
|
|
4605
|
+
/** @description Size identifier */
|
|
4606
|
+
sizeId: string;
|
|
4607
|
+
/** @description Unique client's number. */
|
|
4608
|
+
clientId: string;
|
|
4609
|
+
/** @description Reservation type */
|
|
4610
|
+
type: string;
|
|
4611
|
+
/** @description Last note to reservation */
|
|
4612
|
+
lastNote: {
|
|
4613
|
+
/** @description Login of a panel user that added a note */
|
|
4614
|
+
user: string;
|
|
4615
|
+
/** @description Date of adding a note */
|
|
4616
|
+
date: string;
|
|
4617
|
+
/** @description Content of the note */
|
|
4618
|
+
note: string;
|
|
4619
|
+
};
|
|
4620
|
+
}[];
|
|
4621
|
+
} | {
|
|
4622
|
+
/** @description Information on error that occurred during gate call. */
|
|
4623
|
+
errors?: FaultCodeString;
|
|
4624
|
+
})[];
|
|
4625
|
+
};
|
|
4626
|
+
};
|
|
4627
|
+
|
|
4628
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4629
|
+
export type GetProductsSeriesResponse = {
|
|
4630
|
+
/** @description Date of last modification (YYYY-MM-DD HH-MM-SS). */
|
|
4631
|
+
last_changed_time: string;
|
|
4632
|
+
/** @description Series list. */
|
|
4633
|
+
series: {
|
|
4634
|
+
/** @description Series Id. */
|
|
4635
|
+
id: number;
|
|
4636
|
+
/** @description Name. */
|
|
4637
|
+
name: string;
|
|
4638
|
+
lang_data: {
|
|
4639
|
+
/** @description Language code. Codes are compliant with ISO-639-3 standard. */
|
|
4640
|
+
lang_id: string;
|
|
4641
|
+
/** @description Name. */
|
|
4642
|
+
name: string;
|
|
4643
|
+
/** @description Additional text on product's pages. */
|
|
4644
|
+
desc_search: string;
|
|
4645
|
+
/** @description Additional text in product tab. */
|
|
4646
|
+
desc_projector: string;
|
|
4647
|
+
}[];
|
|
4648
|
+
}[];
|
|
4649
|
+
} & PagedResponse;
|
|
4650
|
+
|
|
4651
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4652
|
+
export type GetShopsCurrenciesResponse = {
|
|
4653
|
+
/** @description List of shops */
|
|
4654
|
+
shops: {
|
|
4655
|
+
/** @description Shop ID */
|
|
4656
|
+
shopId: number;
|
|
4657
|
+
/** @description Shop name */
|
|
4658
|
+
shopName: string;
|
|
4659
|
+
/** @description Currency setting inherited from another shop */
|
|
4660
|
+
inherited: boolean;
|
|
4661
|
+
/** @description List of available languages */
|
|
4662
|
+
currencies: {
|
|
4663
|
+
/** @description Currency name */
|
|
4664
|
+
currency: string;
|
|
4665
|
+
/** @description Is the currency allowed for orders */
|
|
4666
|
+
allowedForOrders: boolean;
|
|
4667
|
+
}[];
|
|
4668
|
+
}[];
|
|
4669
|
+
};
|
|
4670
|
+
|
|
4671
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4672
|
+
export type GetShopsLanguagesResponse = {
|
|
4673
|
+
/** @description List of shops */
|
|
4674
|
+
shops: {
|
|
4675
|
+
/** @description Shop ID */
|
|
4676
|
+
shopId: number;
|
|
4677
|
+
/** @description Shop name */
|
|
4678
|
+
shopName: string;
|
|
4679
|
+
/** @description Language setting inherited from another shop */
|
|
4680
|
+
inherited: boolean;
|
|
4681
|
+
/** @description List of available languages */
|
|
4682
|
+
languages: {
|
|
4683
|
+
/** @description Language id */
|
|
4684
|
+
id: string;
|
|
4685
|
+
/** @description Language name */
|
|
4686
|
+
name: string;
|
|
4687
|
+
/** @description Language ISO code */
|
|
4688
|
+
isoCode: string;
|
|
4689
|
+
/** @example true */
|
|
4690
|
+
enabled: boolean;
|
|
4691
|
+
/** @description Is the the language set as default */
|
|
4692
|
+
isDefault: boolean;
|
|
4693
|
+
}[];
|
|
4694
|
+
}[];
|
|
4695
|
+
};
|
|
4696
|
+
|
|
4697
|
+
export type GetConfigVariablesResponse = {
|
|
4698
|
+
results: ({
|
|
4699
|
+
/** @description Key of config value. */
|
|
4700
|
+
key: string;
|
|
4701
|
+
/** @description Name of config item. */
|
|
4702
|
+
readonly name: string;
|
|
4703
|
+
/** @description Value of config item. */
|
|
4704
|
+
value: string;
|
|
4705
|
+
} & {
|
|
4706
|
+
/** @description The type of module for which the configuration is used */
|
|
4707
|
+
type: "snippets_campaign";
|
|
4708
|
+
/** @description Identifier of the item in used module */
|
|
4709
|
+
itemId: number;
|
|
4710
|
+
/** @description Name of config item. */
|
|
4711
|
+
name: string;
|
|
4712
|
+
})[];
|
|
4713
|
+
pagination: PagedResponse;
|
|
4714
|
+
};
|
|
4715
|
+
|
|
4716
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4717
|
+
export type GetSystemCurrenciesResponse = {
|
|
4718
|
+
/** @description Number of decimal spaces for price rounding. */
|
|
4719
|
+
currency_round: number;
|
|
4720
|
+
currencies: {
|
|
4721
|
+
/** @description Currency ID. */
|
|
4722
|
+
id: string;
|
|
4723
|
+
/** @description Rate. */
|
|
4724
|
+
rate: number;
|
|
4725
|
+
/** @description Unit. */
|
|
4726
|
+
scale: number;
|
|
4727
|
+
/** @description Currency symbol. */
|
|
4728
|
+
symbol: string;
|
|
4729
|
+
/** @description Currency country code. */
|
|
4730
|
+
country_code: string;
|
|
4731
|
+
/** @description Element determines whether currency is active. List of values: "all" - currency is visible and applies both in panel and store, "panel" - currency applies and is visible only in panel, "n" - currency is not visible (does not apply). */
|
|
4732
|
+
active: string;
|
|
4733
|
+
}[];
|
|
4734
|
+
};
|
|
4735
|
+
|
|
4736
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4737
|
+
export type GetPackagesLabelsResponse = {
|
|
4738
|
+
/** @description Package labels encoded in base64 */
|
|
4739
|
+
labels: string[];
|
|
4740
|
+
/** @description Label type */
|
|
4741
|
+
labelsType: "PDF" | "A4" | "16x10" | "SPL" | "ZPL" | "EPL" | "DPL";
|
|
4742
|
+
};
|
|
4743
|
+
|
|
4744
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4745
|
+
export type GetOrdersProfitabilityResponse = {
|
|
4746
|
+
/** @description Order value (net) */
|
|
4747
|
+
totalPrice: number;
|
|
4748
|
+
/** @description Cost or purchasing products (net) */
|
|
4749
|
+
purchasePrice: number;
|
|
4750
|
+
/** @description Payment costs borne by the store (net) */
|
|
4751
|
+
shopPayformCost: number;
|
|
4752
|
+
/** @description Cost for shop. */
|
|
4753
|
+
shippingShopCosts: number;
|
|
4754
|
+
/** @description Insurance cost borne by the store (net) */
|
|
4755
|
+
insuranceShopCosts: number;
|
|
4756
|
+
/** @description Costs of gaining order (net) */
|
|
4757
|
+
acquisitionCost: number;
|
|
4758
|
+
/** @description Profit margin (gain from order) */
|
|
4759
|
+
profitMargin: number;
|
|
4760
|
+
/** @description Percentage margin (gain from order) */
|
|
4761
|
+
profitMarginPercent: number;
|
|
4762
|
+
};
|
|
4763
|
+
|
|
4764
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4765
|
+
export type GetOrdersPackagesResponse = {
|
|
4766
|
+
/** @description Object contains detailed information on result of operation. */
|
|
4767
|
+
results: {
|
|
4768
|
+
/** @description Information on error that occurred during gate call. */
|
|
4769
|
+
errors?: FaultCodeString;
|
|
4770
|
+
/** @description Package details. */
|
|
4771
|
+
deliveryPackage: {} | {
|
|
4772
|
+
/** @description Shipment ID. */
|
|
4773
|
+
deliveryPackageId: number;
|
|
4774
|
+
/** @description Package number. */
|
|
4775
|
+
deliveryPackageNumber: string;
|
|
4776
|
+
/** @description consignment number. */
|
|
4777
|
+
deliveryShippingNumber: string;
|
|
4778
|
+
/** @description Courier ID. */
|
|
4779
|
+
courierId: number;
|
|
4780
|
+
/** @description Name of the supplier of the shipment. */
|
|
4781
|
+
courierName: string;
|
|
4782
|
+
/** @description Selected delivery date. */
|
|
4783
|
+
deliveryDate: string;
|
|
4784
|
+
/** @description Additional information on delivery date. */
|
|
4785
|
+
deliveryDateAdditional: string;
|
|
4786
|
+
/** @description Estimated date of shipment of the order. */
|
|
4787
|
+
estimatedDeliveryDate: string;
|
|
4788
|
+
/** @description Date of receipt by the buyer, possible formats: "YYYY-MM-dd HH:mm:ss", "YYYY-MM-dd", */
|
|
4789
|
+
receivedDate: string;
|
|
4790
|
+
/** @description Package parameters. */
|
|
4791
|
+
deliveryPackageParameters: {
|
|
4792
|
+
/** @description Cash on delivery. */
|
|
4793
|
+
cashOnDelivery: number;
|
|
4794
|
+
/** @description Postal cash on delivery currency. */
|
|
4795
|
+
cashOnDeliveryCurrency: string;
|
|
4796
|
+
/** @description Parcel weight. */
|
|
4797
|
+
deliveryWeight: number;
|
|
4798
|
+
/** @description Link to package tracing. */
|
|
4799
|
+
trackingUrl: string;
|
|
4800
|
+
/** @description Cost for shop. */
|
|
4801
|
+
shippingStoreCosts: {
|
|
4802
|
+
/** @description Package sending net cost. */
|
|
4803
|
+
shippingStoreCostNet: number;
|
|
4804
|
+
/** @description VAT rate for cost of package sending. */
|
|
4805
|
+
shippingStoreCostVat: number;
|
|
4806
|
+
/** @description Package sending gross cost. */
|
|
4807
|
+
shippingStoreCostGross: number;
|
|
4808
|
+
}[];
|
|
4809
|
+
/** @description Package cost. */
|
|
4810
|
+
shippingCosts: {
|
|
4811
|
+
/** @description Package sending net cost. */
|
|
4812
|
+
shippingCostNet: number;
|
|
4813
|
+
/** @description VAT rate for cost of package sending. */
|
|
4814
|
+
shippingCostVat: number;
|
|
4815
|
+
/** @description Package sending gross cost. */
|
|
4816
|
+
shippingCostGross: number;
|
|
4817
|
+
}[];
|
|
4818
|
+
/** @description Shipment configuration options available for a given courier */
|
|
4819
|
+
parcelParameters: {
|
|
4820
|
+
/** @description Key */
|
|
4821
|
+
key: string;
|
|
4822
|
+
/** @description Name */
|
|
4823
|
+
name: string;
|
|
4824
|
+
/** @description Type */
|
|
4825
|
+
type: "radio" | "text" | "select" | "checkbox";
|
|
4826
|
+
/** @description Default value for option */
|
|
4827
|
+
defaultValue: string;
|
|
4828
|
+
/** @description Available values for the options */
|
|
4829
|
+
options?: {
|
|
4830
|
+
/** @description Id */
|
|
4831
|
+
id: string;
|
|
4832
|
+
/** @description Name */
|
|
4833
|
+
name: string;
|
|
4834
|
+
}[];
|
|
4835
|
+
}[];
|
|
4836
|
+
/** @description Information on error that occurred during gate call. */
|
|
4837
|
+
errors?: FaultCodeString;
|
|
4838
|
+
};
|
|
4839
|
+
};
|
|
4840
|
+
/** @description Type. */
|
|
4841
|
+
eventType: string;
|
|
4842
|
+
/** @description Id. */
|
|
4843
|
+
eventId: number;
|
|
4844
|
+
/** @description Parcel label encoded with base64 algorythm. */
|
|
4845
|
+
label?: string;
|
|
4846
|
+
}[];
|
|
4847
|
+
};
|
|
4848
|
+
|
|
4849
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4850
|
+
export type GetOrdersAnalyticsResponse = {
|
|
4851
|
+
/** @description Object contains detailed information on result of operation. */
|
|
4852
|
+
results: null | {
|
|
4853
|
+
/** @description Order serial number. */
|
|
4854
|
+
orderSerialNumber: number;
|
|
4855
|
+
/** @description The list of products returned due to a gate call */
|
|
4856
|
+
productsMargins: {
|
|
4857
|
+
/** @description Stock keeping unit */
|
|
4858
|
+
productId: number;
|
|
4859
|
+
/** @description Size identifier */
|
|
4860
|
+
sizeId: string;
|
|
4861
|
+
/** @description Unit margin for gross product. */
|
|
4862
|
+
productProfitMargin: number;
|
|
4863
|
+
/** @description Unit margin for the net product. */
|
|
4864
|
+
productProfitMarginNet: number;
|
|
4865
|
+
/** @description Returns the number of goods in the order */
|
|
4866
|
+
productQuantity: number;
|
|
4867
|
+
/** @description Item in basket. */
|
|
4868
|
+
basketPosition: number;
|
|
4869
|
+
}[];
|
|
4870
|
+
}[];
|
|
4871
|
+
};
|
|
4872
|
+
|
|
4873
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4874
|
+
export type GetCouriersAssignedToShippingProfilesResponse = {
|
|
4875
|
+
couriers: {
|
|
4876
|
+
[courier: string]: {
|
|
4877
|
+
/** @description Courier Id */
|
|
4878
|
+
id: string;
|
|
4879
|
+
/** @description #!RegionKuriera!# */
|
|
4880
|
+
region: string;
|
|
4881
|
+
/** @description Courier name */
|
|
4882
|
+
name: string;
|
|
4883
|
+
/** @example trackingurl */
|
|
4884
|
+
trackingurl: string;
|
|
4885
|
+
/** @example pickup */
|
|
4886
|
+
pickup: string;
|
|
4887
|
+
/** @example multiple_packages_support */
|
|
4888
|
+
multiple_packages_support: string;
|
|
4889
|
+
/** @example webservice_only */
|
|
4890
|
+
webservice_only: string;
|
|
4891
|
+
/** @example shipping_number_support */
|
|
4892
|
+
shipping_number_support: string;
|
|
4893
|
+
/** @example package_number_support */
|
|
4894
|
+
package_number_support: string
|
|
4895
|
+
} | []
|
|
4896
|
+
};
|
|
4897
|
+
};
|
|
4898
|
+
|
|
4899
|
+
/** @version v6.3 Typechecked 2025-08-23 */
|
|
4900
|
+
export type GetOrdersStatusesResponse = {
|
|
4901
|
+
statuses: {
|
|
4902
|
+
/** @description Status identifier */
|
|
4903
|
+
id: number;
|
|
4904
|
+
/** @description Parent status identifier */
|
|
4905
|
+
parentId: number | null;
|
|
4906
|
+
/** @example Packed by Employee#1 */
|
|
4907
|
+
panelName: string;
|
|
4908
|
+
}[];
|
|
4909
|
+
};
|
|
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
|
+
|
|
5606
|
+
export { };
|