@gofynd/fdk-client-javascript 1.6.0 → 1.6.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/platform/Cart/CartPlatformModel.d.ts +32 -1
- package/sdk/platform/Cart/CartPlatformModel.js +20 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +1 -1
- package/sdk/platform/Order/OrderPlatformClient.js +12 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -0
- package/sdk/platform/Order/OrderPlatformValidator.js +15 -0
package/README.md
CHANGED
|
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
237
237
|
The above code will log the curl command in the console
|
|
238
238
|
|
|
239
239
|
```bash
|
|
240
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.6.
|
|
240
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.6.2' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
241
241
|
Active Theme: Emerge
|
|
242
242
|
```
|
|
243
243
|
|
package/package.json
CHANGED
|
@@ -1950,6 +1950,11 @@ export = CartPlatformModel;
|
|
|
1950
1950
|
* @property {string} key - Key name of custom meta
|
|
1951
1951
|
* @property {string} value - Value to be added in key
|
|
1952
1952
|
*/
|
|
1953
|
+
/**
|
|
1954
|
+
* @typedef OrderTag
|
|
1955
|
+
* @property {string} [display_text] - Display text for order tag
|
|
1956
|
+
* @property {string} [slug] - Slug to be used for tagging order with any unique value
|
|
1957
|
+
*/
|
|
1953
1958
|
/**
|
|
1954
1959
|
* @typedef PlatformCartCheckoutDetailCreation
|
|
1955
1960
|
* @property {CartCheckoutCustomMeta[]} [custom_meta]
|
|
@@ -1987,6 +1992,8 @@ export = CartPlatformModel;
|
|
|
1987
1992
|
* redirected after payment received
|
|
1988
1993
|
* @property {string} [failure_callback_url] - Failure callback url to be
|
|
1989
1994
|
* redirected after payment failed
|
|
1995
|
+
* @property {OrderTag[]} [order_tags] - Order tags used to identify specific
|
|
1996
|
+
* type of order which is tagged using order tags
|
|
1990
1997
|
*/
|
|
1991
1998
|
/**
|
|
1992
1999
|
* @typedef CheckCart
|
|
@@ -2189,6 +2196,8 @@ export = CartPlatformModel;
|
|
|
2189
2196
|
* redirected after payment received
|
|
2190
2197
|
* @property {string} [failure_callback_url] - Failure callback url to be
|
|
2191
2198
|
* redirected after payment failed
|
|
2199
|
+
* @property {OrderTag[]} [order_tags] - Order tags used to identify specific
|
|
2200
|
+
* type of order which is tagged using order tags
|
|
2192
2201
|
*/
|
|
2193
2202
|
/**
|
|
2194
2203
|
* @typedef UpdateCartPaymentRequestV2
|
|
@@ -2281,7 +2290,7 @@ export = CartPlatformModel;
|
|
|
2281
2290
|
declare class CartPlatformModel {
|
|
2282
2291
|
}
|
|
2283
2292
|
declare namespace CartPlatformModel {
|
|
2284
|
-
export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError };
|
|
2293
|
+
export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError };
|
|
2285
2294
|
}
|
|
2286
2295
|
/** @returns {CouponDateMeta} */
|
|
2287
2296
|
declare function CouponDateMeta(): CouponDateMeta;
|
|
@@ -7207,6 +7216,18 @@ type CartCheckoutCustomMeta = {
|
|
|
7207
7216
|
*/
|
|
7208
7217
|
value: string;
|
|
7209
7218
|
};
|
|
7219
|
+
/** @returns {OrderTag} */
|
|
7220
|
+
declare function OrderTag(): OrderTag;
|
|
7221
|
+
type OrderTag = {
|
|
7222
|
+
/**
|
|
7223
|
+
* - Display text for order tag
|
|
7224
|
+
*/
|
|
7225
|
+
display_text?: string;
|
|
7226
|
+
/**
|
|
7227
|
+
* - Slug to be used for tagging order with any unique value
|
|
7228
|
+
*/
|
|
7229
|
+
slug?: string;
|
|
7230
|
+
};
|
|
7210
7231
|
/** @returns {PlatformCartCheckoutDetailCreation} */
|
|
7211
7232
|
declare function PlatformCartCheckoutDetailCreation(): PlatformCartCheckoutDetailCreation;
|
|
7212
7233
|
type PlatformCartCheckoutDetailCreation = {
|
|
@@ -7257,6 +7278,11 @@ type PlatformCartCheckoutDetailCreation = {
|
|
|
7257
7278
|
* redirected after payment failed
|
|
7258
7279
|
*/
|
|
7259
7280
|
failure_callback_url?: string;
|
|
7281
|
+
/**
|
|
7282
|
+
* - Order tags used to identify specific
|
|
7283
|
+
* type of order which is tagged using order tags
|
|
7284
|
+
*/
|
|
7285
|
+
order_tags?: OrderTag[];
|
|
7260
7286
|
};
|
|
7261
7287
|
/** @returns {CheckCart} */
|
|
7262
7288
|
declare function CheckCart(): CheckCart;
|
|
@@ -7795,6 +7821,11 @@ type PlatformCartCheckoutDetailV2Creation = {
|
|
|
7795
7821
|
* redirected after payment failed
|
|
7796
7822
|
*/
|
|
7797
7823
|
failure_callback_url?: string;
|
|
7824
|
+
/**
|
|
7825
|
+
* - Order tags used to identify specific
|
|
7826
|
+
* type of order which is tagged using order tags
|
|
7827
|
+
*/
|
|
7828
|
+
order_tags?: OrderTag[];
|
|
7798
7829
|
};
|
|
7799
7830
|
/** @returns {UpdateCartPaymentRequestV2} */
|
|
7800
7831
|
declare function UpdateCartPaymentRequestV2(): UpdateCartPaymentRequestV2;
|
|
@@ -2131,6 +2131,12 @@ const Joi = require("joi");
|
|
|
2131
2131
|
* @property {string} value - Value to be added in key
|
|
2132
2132
|
*/
|
|
2133
2133
|
|
|
2134
|
+
/**
|
|
2135
|
+
* @typedef OrderTag
|
|
2136
|
+
* @property {string} [display_text] - Display text for order tag
|
|
2137
|
+
* @property {string} [slug] - Slug to be used for tagging order with any unique value
|
|
2138
|
+
*/
|
|
2139
|
+
|
|
2134
2140
|
/**
|
|
2135
2141
|
* @typedef PlatformCartCheckoutDetailCreation
|
|
2136
2142
|
* @property {CartCheckoutCustomMeta[]} [custom_meta]
|
|
@@ -2168,6 +2174,8 @@ const Joi = require("joi");
|
|
|
2168
2174
|
* redirected after payment received
|
|
2169
2175
|
* @property {string} [failure_callback_url] - Failure callback url to be
|
|
2170
2176
|
* redirected after payment failed
|
|
2177
|
+
* @property {OrderTag[]} [order_tags] - Order tags used to identify specific
|
|
2178
|
+
* type of order which is tagged using order tags
|
|
2171
2179
|
*/
|
|
2172
2180
|
|
|
2173
2181
|
/**
|
|
@@ -2382,6 +2390,8 @@ const Joi = require("joi");
|
|
|
2382
2390
|
* redirected after payment received
|
|
2383
2391
|
* @property {string} [failure_callback_url] - Failure callback url to be
|
|
2384
2392
|
* redirected after payment failed
|
|
2393
|
+
* @property {OrderTag[]} [order_tags] - Order tags used to identify specific
|
|
2394
|
+
* type of order which is tagged using order tags
|
|
2385
2395
|
*/
|
|
2386
2396
|
|
|
2387
2397
|
/**
|
|
@@ -4709,6 +4719,14 @@ class CartPlatformModel {
|
|
|
4709
4719
|
});
|
|
4710
4720
|
}
|
|
4711
4721
|
|
|
4722
|
+
/** @returns {OrderTag} */
|
|
4723
|
+
static OrderTag() {
|
|
4724
|
+
return Joi.object({
|
|
4725
|
+
display_text: Joi.string().allow(""),
|
|
4726
|
+
slug: Joi.string().allow(""),
|
|
4727
|
+
});
|
|
4728
|
+
}
|
|
4729
|
+
|
|
4712
4730
|
/** @returns {PlatformCartCheckoutDetailCreation} */
|
|
4713
4731
|
static PlatformCartCheckoutDetailCreation() {
|
|
4714
4732
|
return Joi.object({
|
|
@@ -4747,6 +4765,7 @@ class CartPlatformModel {
|
|
|
4747
4765
|
card_id: Joi.string().allow(""),
|
|
4748
4766
|
success_callback_url: Joi.string().allow("").allow(null),
|
|
4749
4767
|
failure_callback_url: Joi.string().allow("").allow(null),
|
|
4768
|
+
order_tags: Joi.array().items(CartPlatformModel.OrderTag()),
|
|
4750
4769
|
});
|
|
4751
4770
|
}
|
|
4752
4771
|
|
|
@@ -4948,6 +4967,7 @@ class CartPlatformModel {
|
|
|
4948
4967
|
card_id: Joi.string().allow(""),
|
|
4949
4968
|
success_callback_url: Joi.string().allow("").allow(null),
|
|
4950
4969
|
failure_callback_url: Joi.string().allow("").allow(null),
|
|
4970
|
+
order_tags: Joi.array().items(CartPlatformModel.OrderTag()),
|
|
4951
4971
|
});
|
|
4952
4972
|
}
|
|
4953
4973
|
|
|
@@ -401,7 +401,7 @@ declare class Order {
|
|
|
401
401
|
* @summary: List shipments
|
|
402
402
|
* @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
|
|
403
403
|
*/
|
|
404
|
-
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
|
|
404
|
+
getShipments({ lane, bagStatus, statusAssigned, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, statusAssignedStartDate, statusAssignedEndDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
|
|
405
405
|
/**
|
|
406
406
|
* @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
|
|
407
407
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -3337,6 +3337,7 @@ class Order {
|
|
|
3337
3337
|
{
|
|
3338
3338
|
lane,
|
|
3339
3339
|
bagStatus,
|
|
3340
|
+
statusAssigned,
|
|
3340
3341
|
statusOverrideLane,
|
|
3341
3342
|
timeToDispatch,
|
|
3342
3343
|
searchType,
|
|
@@ -3345,6 +3346,8 @@ class Order {
|
|
|
3345
3346
|
toDate,
|
|
3346
3347
|
startDate,
|
|
3347
3348
|
endDate,
|
|
3349
|
+
statusAssignedStartDate,
|
|
3350
|
+
statusAssignedEndDate,
|
|
3348
3351
|
dpIds,
|
|
3349
3352
|
stores,
|
|
3350
3353
|
salesChannels,
|
|
@@ -3377,6 +3380,7 @@ class Order {
|
|
|
3377
3380
|
{
|
|
3378
3381
|
lane,
|
|
3379
3382
|
bagStatus,
|
|
3383
|
+
statusAssigned,
|
|
3380
3384
|
statusOverrideLane,
|
|
3381
3385
|
timeToDispatch,
|
|
3382
3386
|
searchType,
|
|
@@ -3385,6 +3389,8 @@ class Order {
|
|
|
3385
3389
|
toDate,
|
|
3386
3390
|
startDate,
|
|
3387
3391
|
endDate,
|
|
3392
|
+
statusAssignedStartDate,
|
|
3393
|
+
statusAssignedEndDate,
|
|
3388
3394
|
dpIds,
|
|
3389
3395
|
stores,
|
|
3390
3396
|
salesChannels,
|
|
@@ -3421,6 +3427,7 @@ class Order {
|
|
|
3421
3427
|
{
|
|
3422
3428
|
lane,
|
|
3423
3429
|
bagStatus,
|
|
3430
|
+
statusAssigned,
|
|
3424
3431
|
statusOverrideLane,
|
|
3425
3432
|
timeToDispatch,
|
|
3426
3433
|
searchType,
|
|
@@ -3429,6 +3436,8 @@ class Order {
|
|
|
3429
3436
|
toDate,
|
|
3430
3437
|
startDate,
|
|
3431
3438
|
endDate,
|
|
3439
|
+
statusAssignedStartDate,
|
|
3440
|
+
statusAssignedEndDate,
|
|
3432
3441
|
dpIds,
|
|
3433
3442
|
stores,
|
|
3434
3443
|
salesChannels,
|
|
@@ -3466,6 +3475,7 @@ class Order {
|
|
|
3466
3475
|
const query_params = {};
|
|
3467
3476
|
query_params["lane"] = lane;
|
|
3468
3477
|
query_params["bag_status"] = bagStatus;
|
|
3478
|
+
query_params["status_assigned"] = statusAssigned;
|
|
3469
3479
|
query_params["status_override_lane"] = statusOverrideLane;
|
|
3470
3480
|
query_params["time_to_dispatch"] = timeToDispatch;
|
|
3471
3481
|
query_params["search_type"] = searchType;
|
|
@@ -3474,6 +3484,8 @@ class Order {
|
|
|
3474
3484
|
query_params["to_date"] = toDate;
|
|
3475
3485
|
query_params["start_date"] = startDate;
|
|
3476
3486
|
query_params["end_date"] = endDate;
|
|
3487
|
+
query_params["status_assigned_start_date"] = statusAssignedStartDate;
|
|
3488
|
+
query_params["status_assigned_end_date"] = statusAssignedEndDate;
|
|
3477
3489
|
query_params["dp_ids"] = dpIds;
|
|
3478
3490
|
query_params["stores"] = stores;
|
|
3479
3491
|
query_params["sales_channels"] = salesChannels;
|
|
@@ -292,6 +292,9 @@ export = OrderPlatformValidator;
|
|
|
292
292
|
* @typedef GetShipmentsParam
|
|
293
293
|
* @property {string} [lane] - Name of lane for which data is to be fetched
|
|
294
294
|
* @property {string} [bagStatus] - Comma separated values of bag statuses.
|
|
295
|
+
* @property {string} [statusAssigned] - Used to filter shipments based on
|
|
296
|
+
* status present in shipment_status_history. For more information on these
|
|
297
|
+
* statuses, refer to the Fynd Partners documentation.
|
|
295
298
|
* @property {boolean} [statusOverrideLane] - Use this flag to fetch by
|
|
296
299
|
* bag_status and override lane.
|
|
297
300
|
* @property {number} [timeToDispatch] - Indicates the time to dispatch.
|
|
@@ -305,6 +308,15 @@ export = OrderPlatformValidator;
|
|
|
305
308
|
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
306
309
|
* @property {string} [endDate] - The UTC end date in ISO format
|
|
307
310
|
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
311
|
+
* @property {string} [statusAssignedStartDate] - Specifies the starting UTC
|
|
312
|
+
* date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
|
|
313
|
+
* boundary for filtering shipments based on the `created_at` timestamp of
|
|
314
|
+
* statuses in the shipment's status history. It allows filtering statuses
|
|
315
|
+
* that were created within a specific time range.
|
|
316
|
+
* @property {string} [statusAssignedEndDate] - Specifies the ending UTC date
|
|
317
|
+
* and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
|
|
318
|
+
* for filtering shipments based on the `created_at` timestamp of statuses in
|
|
319
|
+
* the shipment's status history.
|
|
308
320
|
* @property {string} [dpIds] - A comma-separated list of delivery partner IDs
|
|
309
321
|
* to filter results by specific delivery partners.
|
|
310
322
|
* @property {string} [stores] - A comma-separated list of store IDs used to
|
|
@@ -1150,6 +1162,12 @@ type GetShipmentsParam = {
|
|
|
1150
1162
|
* - Comma separated values of bag statuses.
|
|
1151
1163
|
*/
|
|
1152
1164
|
bagStatus?: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* - Used to filter shipments based on
|
|
1167
|
+
* status present in shipment_status_history. For more information on these
|
|
1168
|
+
* statuses, refer to the Fynd Partners documentation.
|
|
1169
|
+
*/
|
|
1170
|
+
statusAssigned?: string;
|
|
1153
1171
|
/**
|
|
1154
1172
|
* - Use this flag to fetch by
|
|
1155
1173
|
* bag_status and override lane.
|
|
@@ -1187,6 +1205,21 @@ type GetShipmentsParam = {
|
|
|
1187
1205
|
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
1188
1206
|
*/
|
|
1189
1207
|
endDate?: string;
|
|
1208
|
+
/**
|
|
1209
|
+
* - Specifies the starting UTC
|
|
1210
|
+
* date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
|
|
1211
|
+
* boundary for filtering shipments based on the `created_at` timestamp of
|
|
1212
|
+
* statuses in the shipment's status history. It allows filtering statuses
|
|
1213
|
+
* that were created within a specific time range.
|
|
1214
|
+
*/
|
|
1215
|
+
statusAssignedStartDate?: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* - Specifies the ending UTC date
|
|
1218
|
+
* and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
|
|
1219
|
+
* for filtering shipments based on the `created_at` timestamp of statuses in
|
|
1220
|
+
* the shipment's status history.
|
|
1221
|
+
*/
|
|
1222
|
+
statusAssignedEndDate?: string;
|
|
1190
1223
|
/**
|
|
1191
1224
|
* - A comma-separated list of delivery partner IDs
|
|
1192
1225
|
* to filter results by specific delivery partners.
|
|
@@ -331,6 +331,9 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
331
331
|
* @typedef GetShipmentsParam
|
|
332
332
|
* @property {string} [lane] - Name of lane for which data is to be fetched
|
|
333
333
|
* @property {string} [bagStatus] - Comma separated values of bag statuses.
|
|
334
|
+
* @property {string} [statusAssigned] - Used to filter shipments based on
|
|
335
|
+
* status present in shipment_status_history. For more information on these
|
|
336
|
+
* statuses, refer to the Fynd Partners documentation.
|
|
334
337
|
* @property {boolean} [statusOverrideLane] - Use this flag to fetch by
|
|
335
338
|
* bag_status and override lane.
|
|
336
339
|
* @property {number} [timeToDispatch] - Indicates the time to dispatch.
|
|
@@ -344,6 +347,15 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
344
347
|
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
345
348
|
* @property {string} [endDate] - The UTC end date in ISO format
|
|
346
349
|
* (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
|
|
350
|
+
* @property {string} [statusAssignedStartDate] - Specifies the starting UTC
|
|
351
|
+
* date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
|
|
352
|
+
* boundary for filtering shipments based on the `created_at` timestamp of
|
|
353
|
+
* statuses in the shipment's status history. It allows filtering statuses
|
|
354
|
+
* that were created within a specific time range.
|
|
355
|
+
* @property {string} [statusAssignedEndDate] - Specifies the ending UTC date
|
|
356
|
+
* and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
|
|
357
|
+
* for filtering shipments based on the `created_at` timestamp of statuses in
|
|
358
|
+
* the shipment's status history.
|
|
347
359
|
* @property {string} [dpIds] - A comma-separated list of delivery partner IDs
|
|
348
360
|
* to filter results by specific delivery partners.
|
|
349
361
|
* @property {string} [stores] - A comma-separated list of store IDs used to
|
|
@@ -856,6 +868,7 @@ class OrderPlatformValidator {
|
|
|
856
868
|
return Joi.object({
|
|
857
869
|
lane: Joi.string().allow(""),
|
|
858
870
|
bagStatus: Joi.string().allow(""),
|
|
871
|
+
statusAssigned: Joi.string().allow(""),
|
|
859
872
|
statusOverrideLane: Joi.boolean(),
|
|
860
873
|
timeToDispatch: Joi.number(),
|
|
861
874
|
searchType: Joi.string().allow(""),
|
|
@@ -864,6 +877,8 @@ class OrderPlatformValidator {
|
|
|
864
877
|
toDate: Joi.string().allow(""),
|
|
865
878
|
startDate: Joi.string().allow(""),
|
|
866
879
|
endDate: Joi.string().allow(""),
|
|
880
|
+
statusAssignedStartDate: Joi.string().allow(""),
|
|
881
|
+
statusAssignedEndDate: Joi.string().allow(""),
|
|
867
882
|
dpIds: Joi.string().allow(""),
|
|
868
883
|
stores: Joi.string().allow(""),
|
|
869
884
|
salesChannels: Joi.string().allow(""),
|