@gofynd/fdk-client-javascript 3.3.6 → 3.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.
Files changed (54) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
  4. package/sdk/application/Catalog/CatalogApplicationClient.js +24 -5
  5. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -0
  6. package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
  7. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +115 -47
  8. package/sdk/partner/Logistics/LogisticsPartnerModel.js +67 -35
  9. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
  10. package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
  11. package/sdk/platform/Cart/CartPlatformModel.d.ts +454 -12
  12. package/sdk/platform/Cart/CartPlatformModel.js +457 -10
  13. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  14. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
  15. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +9 -0
  16. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +4 -0
  17. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
  18. package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
  19. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
  20. package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
  21. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
  22. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
  23. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  24. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  25. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
  26. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
  27. package/sdk/platform/Content/ContentPlatformModel.d.ts +14 -19
  28. package/sdk/platform/Content/ContentPlatformModel.js +6 -20
  29. package/sdk/platform/Order/OrderPlatformModel.d.ts +237 -17
  30. package/sdk/platform/Order/OrderPlatformModel.js +388 -14
  31. package/sdk/platform/Order/OrderPlatformValidator.d.ts +15 -15
  32. package/sdk/platform/Order/OrderPlatformValidator.js +9 -9
  33. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -5
  34. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +4 -3
  35. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +97 -1
  36. package/sdk/platform/Payment/PaymentPlatformModel.js +273 -0
  37. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
  38. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
  39. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
  40. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
  41. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
  42. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
  43. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1033 -113
  44. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +613 -35
  45. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
  46. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
  47. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
  48. package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
  49. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
  50. package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
  51. package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
  52. package/sdk/platform/User/UserPlatformModel.js +276 -7
  53. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
  54. package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
@@ -266,6 +266,39 @@ export = OrderPlatformModel;
266
266
  * @property {Object} [data] - Encapsulates a dynamic set of updates and
267
267
  * modifications applied to the order.
268
268
  */
269
+ /**
270
+ * @typedef SellerQCDetailsSchema
271
+ * @property {number} line_number - Line_number of the product/bag.
272
+ * @property {number} good_quantity - The number of units marked as good during
273
+ * the seller QC process for the given line_number/bag item.
274
+ * @property {number} bad_quantity - The number of units marked as bad during
275
+ * the seller QC process for the given line_number/bag item.
276
+ */
277
+ /**
278
+ * @typedef EntityStatusDataSchema
279
+ * @property {SellerQCDetailsSchema[]} [seller_qc_details] - An array of QC
280
+ * results provided by the seller to indicate the condition of returned items
281
+ * (e.g., good vs. bad quantity) for each line item. Pass this field such that
282
+ * if inventory-related data is included, it will be updated accordingly
283
+ * during the transition.
284
+ */
285
+ /**
286
+ * @typedef DataUpdatesFiltersSchema
287
+ * @property {number} [line_number] - Line number of the product/bag.
288
+ * @property {number} [quantity] - Quantity of the line number item.
289
+ * @property {string} [identifier] - Seller identifier of the product/bag.
290
+ */
291
+ /**
292
+ * @typedef EntityStatusDataUpdates
293
+ * @property {DataUpdatesFiltersSchema[]} [filters] - A list of filters used to
294
+ * specify the target for this update. For shipment level or shipment-status
295
+ * level updates, this should be an empty array ([]) as no filters are
296
+ * required during shipment/shipment_status transitions. But is still
297
+ * mandatory due to schema requirements. For product-level updates,
298
+ * appropriate filters must be provided as per the schema to accurately target
299
+ * specific items.
300
+ * @property {EntityStatusDataSchema} [data]
301
+ */
269
302
  /**
270
303
  * @typedef DataUpdates
271
304
  * @property {OrderItemDataUpdates[]} [order_item_status] - A list of updates
@@ -275,6 +308,10 @@ export = OrderPlatformModel;
275
308
  * @property {EntitiesDataUpdates[]} [entities] - A list of updates related to
276
309
  * the properties of any relevant entities.
277
310
  * @property {OrderDataUpdates[]} [order]
311
+ * @property {EntityStatusDataUpdates[]} [entity_status] - A list of updates to
312
+ * entity_status properties associated with specific shipment status
313
+ * transitions (e.g., bag_confirmed, return_accepted). These updates are
314
+ * optional. Update e.g., inventory-affecting data (like QC data) to be updated.
278
315
  */
279
316
  /**
280
317
  * @typedef TransitionComments
@@ -837,7 +874,7 @@ export = OrderPlatformModel;
837
874
  * your order was placed. This field will be phased out after version 2.4.0.
838
875
  * Please use ordering_source instead to ensure accurate order tracking and processing.
839
876
  * @property {string} [ordering_source] - To uniquely identify the source
840
- * through which order has been placed.
877
+ * through which order has been placed (e.g, marketplace, gofynd).
841
878
  * @property {Object} [meta] - Meta data of the order data contains additional,
842
879
  * potentially dynamic information about the order data.
843
880
  * @property {number} [cod_charges]
@@ -2339,7 +2376,7 @@ export = OrderPlatformModel;
2339
2376
  * your order was placed. This field will be phased out after version 2.4.0.
2340
2377
  * Please use ordering_source instead to ensure accurate order tracking and processing.
2341
2378
  * @property {string} [ordering_source] - To uniquely identify the source
2342
- * through which order has been placed.
2379
+ * through which order has been placed (e.g, marketplace, gofynd).
2343
2380
  * @property {string} entity - The type of entity that the configuration pertains to.
2344
2381
  */
2345
2382
  /**
@@ -2705,7 +2742,7 @@ export = OrderPlatformModel;
2705
2742
  * for the address.
2706
2743
  * @property {string} [country_phone_code] - The country-specific phone code for
2707
2744
  * formatting phone numbers.
2708
- * @property {string} [delivery_address_id] - A unique identifier for the
2745
+ * @property {number} [delivery_address_id] - A unique identifier for the
2709
2746
  * delivery address.
2710
2747
  * @property {Object} [geo_location] - An object containing additional
2711
2748
  * geographical information related to the address.
@@ -3356,13 +3393,13 @@ export = OrderPlatformModel;
3356
3393
  * @property {string} [order_date] - Denotes the date and time when an order was
3357
3394
  * placed by the customer. This timestamp is crucial for tracking the order'
3358
3395
  * @property {string} [order_created_ts] - The timestamp indicating when the
3359
- * order was created.
3396
+ * order was created in UTC format.
3360
3397
  * @property {ShipmentStatus} [shipment_status]
3361
3398
  * @property {UserDataInfo} [user]
3362
3399
  * @property {string} [estimated_sla_time] - The estimated Service Level
3363
3400
  * Agreement (SLA) time for the shipment.
3364
3401
  * @property {string} [estimated_sla_ts] - The timestamp for the estimated SLA,
3365
- * providing a specific time for expected delivery.
3402
+ * providing a specific time for expected delivery in UTC format.
3366
3403
  * @property {Address} [delivery_address]
3367
3404
  * @property {Address} [billing_address]
3368
3405
  * @property {AffiliateDetails} [affiliate_details]
@@ -3414,7 +3451,7 @@ export = OrderPlatformModel;
3414
3451
  * your order was placed. This field will be phased out after version 2.4.0.
3415
3452
  * Please use ordering_source instead to ensure accurate order tracking and processing.
3416
3453
  * @property {string} [ordering_source] - To uniquely identify the source
3417
- * through which order has been placed.
3454
+ * through which order has been placed (e.g, marketplace, gofynd).
3418
3455
  * @property {string} [shipment_id] - The unique identifier for the shipment itself.
3419
3456
  * @property {string} [customer_note] - Any special notes or instructions
3420
3457
  * provided by the customer related to the shipment.
@@ -3431,6 +3468,7 @@ export = OrderPlatformModel;
3431
3468
  * @property {Object} [logistics_meta] - An object storing detailed
3432
3469
  * logistics-related information, including courier partner details and other
3433
3470
  * relevant metadata.
3471
+ * @property {FulfillmentOption} [fulfillment_option]
3434
3472
  */
3435
3473
  /**
3436
3474
  * @typedef ShipmentInternalPlatformViewResponseSchema
@@ -3513,7 +3551,7 @@ export = OrderPlatformModel;
3513
3551
  * your order was placed. This field will be phased out after version 2.4.0.
3514
3552
  * Please use ordering_source instead to ensure accurate order tracking and processing.
3515
3553
  * @property {string} [ordering_source] - To uniquely identify the source
3516
- * through which order has been placed.
3554
+ * through which order has been placed (e.g, marketplace, gofynd).
3517
3555
  * @property {Object} [meta] - Meta data of the order contains additional,
3518
3556
  * potentially dynamic information about the order.
3519
3557
  */
@@ -4092,8 +4130,16 @@ export = OrderPlatformModel;
4092
4130
  * 'lock' state prevents any shipment status transitions until a new label is
4093
4131
  * downloaded.
4094
4132
  */
4133
+ /**
4134
+ * @typedef FulfillmentOption
4135
+ * @property {string} [name]
4136
+ * @property {string} [slug]
4137
+ * @property {string} [type]
4138
+ * @property {boolean} [is_default]
4139
+ */
4095
4140
  /**
4096
4141
  * @typedef PlatformShipment
4142
+ * @property {FulfillmentOption} [fulfillment_option]
4097
4143
  * @property {string} [picked_date] - Indicates the date and time when the
4098
4144
  * shipment was physically picked up from the sender or the origin point by
4099
4145
  * the delivery service. This timestamp is crucial for tracking the
@@ -4276,7 +4322,7 @@ export = OrderPlatformModel;
4276
4322
  * your order was placed. This field will be phased out after version 2.4.0.
4277
4323
  * Please use ordering_source instead to ensure accurate order tracking and processing.
4278
4324
  * @property {string} [ordering_source] - To uniquely identify the source
4279
- * through which order has been placed.
4325
+ * through which order has been placed (e.g, marketplace, gofynd).
4280
4326
  * @property {string} order_date - Specifies the exact date and time when the
4281
4327
  * order was placed by the customer, serving as a key timestamp for the
4282
4328
  * initiation of the order processing cycle.
@@ -4944,10 +4990,99 @@ export = OrderPlatformModel;
4944
4990
  * @property {boolean} [status]
4945
4991
  * @property {string} [error]
4946
4992
  */
4993
+ /**
4994
+ * @typedef {| "storefront"
4995
+ * | "store_os_pos"
4996
+ * | "kiosk"
4997
+ * | "scan_go"
4998
+ * | "smart_trolley"
4999
+ * | "gofynd"
5000
+ * | "uniket"
5001
+ * | "marketplace"
5002
+ * | "social_commerce"
5003
+ * | "ondc"
5004
+ * | "nexus"
5005
+ * | "nykaa_fashion"
5006
+ * | "etsy"
5007
+ * | "vuivui"
5008
+ * | "zilingo"
5009
+ * | "firstcry"
5010
+ * | "bukalapak"
5011
+ * | "myntra_ppmp"
5012
+ * | "lazada"
5013
+ * | "tiktok"
5014
+ * | "sfcc"
5015
+ * | "debenhams"
5016
+ * | "prestomall"
5017
+ * | "meesho"
5018
+ * | "amazon_vdf"
5019
+ * | "bigcommerce"
5020
+ * | "sendo"
5021
+ * | "storehippo"
5022
+ * | "cdiscount"
5023
+ * | "nykaa"
5024
+ * | "trendyol"
5025
+ * | "weloveshopping"
5026
+ * | "jollee"
5027
+ * | "wish"
5028
+ * | "tiki"
5029
+ * | "central_online"
5030
+ * | "q10"
5031
+ * | "cred"
5032
+ * | "walmart"
5033
+ * | "snapdeal"
5034
+ * | "flipkart"
5035
+ * | "blibli"
5036
+ * | "ajio_jit"
5037
+ * | "pharmeasy"
5038
+ * | "ezmall"
5039
+ * | "adobe_commerce"
5040
+ * | "kartmax"
5041
+ * | "shopee"
5042
+ * | "zalora"
5043
+ * | "prestashop"
5044
+ * | "smytten"
5045
+ * | "amazon_sc"
5046
+ * | "urbanpiper"
5047
+ * | "flipkart_quick"
5048
+ * | "woocommerce"
5049
+ * | "zivame"
5050
+ * | "lelong"
5051
+ * | "facebook"
5052
+ * | "jiomart"
5053
+ * | "gmc"
5054
+ * | "robins"
5055
+ * | "akulaku"
5056
+ * | "noon"
5057
+ * | "tatacliq"
5058
+ * | "kartrocket"
5059
+ * | "inorbit"
5060
+ * | "ajio_business"
5061
+ * | "swiggy"
5062
+ * | "asos"
5063
+ * | "tokopedia"
5064
+ * | "limeroad"
5065
+ * | "myntra_omni"
5066
+ * | "spoyl"
5067
+ * | "amazon_mlf"
5068
+ * | "fulfilled_by_lazada"
5069
+ * | "ebay"
5070
+ * | "jd"
5071
+ * | "amazon_pharmacy"
5072
+ * | "ajio_vms"
5073
+ * | "daraz"
5074
+ * | "oker"
5075
+ * | "flipkart_b2b"
5076
+ * | "amazon_mlf_ss"
5077
+ * | "woovly"
5078
+ * | "tata1mg"
5079
+ * | "zomato"
5080
+ * | "shopify"} OrderingSource
5081
+ */
4947
5082
  declare class OrderPlatformModel {
4948
5083
  }
4949
5084
  declare namespace OrderPlatformModel {
4950
- export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema };
5085
+ export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema, OrderingSource };
4951
5086
  }
4952
5087
  /** @returns {InvalidateShipmentCachePayload} */
4953
5088
  declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -5521,6 +5656,67 @@ type OrderDataUpdates = {
5521
5656
  */
5522
5657
  data?: any;
5523
5658
  };
5659
+ /** @returns {SellerQCDetailsSchema} */
5660
+ declare function SellerQCDetailsSchema(): SellerQCDetailsSchema;
5661
+ type SellerQCDetailsSchema = {
5662
+ /**
5663
+ * - Line_number of the product/bag.
5664
+ */
5665
+ line_number: number;
5666
+ /**
5667
+ * - The number of units marked as good during
5668
+ * the seller QC process for the given line_number/bag item.
5669
+ */
5670
+ good_quantity: number;
5671
+ /**
5672
+ * - The number of units marked as bad during
5673
+ * the seller QC process for the given line_number/bag item.
5674
+ */
5675
+ bad_quantity: number;
5676
+ };
5677
+ /** @returns {EntityStatusDataSchema} */
5678
+ declare function EntityStatusDataSchema(): EntityStatusDataSchema;
5679
+ type EntityStatusDataSchema = {
5680
+ /**
5681
+ * - An array of QC
5682
+ * results provided by the seller to indicate the condition of returned items
5683
+ * (e.g., good vs. bad quantity) for each line item. Pass this field such that
5684
+ * if inventory-related data is included, it will be updated accordingly
5685
+ * during the transition.
5686
+ */
5687
+ seller_qc_details?: SellerQCDetailsSchema[];
5688
+ };
5689
+ /** @returns {DataUpdatesFiltersSchema} */
5690
+ declare function DataUpdatesFiltersSchema(): DataUpdatesFiltersSchema;
5691
+ type DataUpdatesFiltersSchema = {
5692
+ /**
5693
+ * - Line number of the product/bag.
5694
+ */
5695
+ line_number?: number;
5696
+ /**
5697
+ * - Quantity of the line number item.
5698
+ */
5699
+ quantity?: number;
5700
+ /**
5701
+ * - Seller identifier of the product/bag.
5702
+ */
5703
+ identifier?: string;
5704
+ };
5705
+ /** @returns {EntityStatusDataUpdates} */
5706
+ declare function EntityStatusDataUpdates(): EntityStatusDataUpdates;
5707
+ type EntityStatusDataUpdates = {
5708
+ /**
5709
+ * - A list of filters used to
5710
+ * specify the target for this update. For shipment level or shipment-status
5711
+ * level updates, this should be an empty array ([]) as no filters are
5712
+ * required during shipment/shipment_status transitions. But is still
5713
+ * mandatory due to schema requirements. For product-level updates,
5714
+ * appropriate filters must be provided as per the schema to accurately target
5715
+ * specific items.
5716
+ */
5717
+ filters?: DataUpdatesFiltersSchema[];
5718
+ data?: EntityStatusDataSchema;
5719
+ };
5524
5720
  /** @returns {DataUpdates} */
5525
5721
  declare function DataUpdates(): DataUpdates;
5526
5722
  type DataUpdates = {
@@ -5540,6 +5736,13 @@ type DataUpdates = {
5540
5736
  */
5541
5737
  entities?: EntitiesDataUpdates[];
5542
5738
  order?: OrderDataUpdates[];
5739
+ /**
5740
+ * - A list of updates to
5741
+ * entity_status properties associated with specific shipment status
5742
+ * transitions (e.g., bag_confirmed, return_accepted). These updates are
5743
+ * optional. Update e.g., inventory-affecting data (like QC data) to be updated.
5744
+ */
5745
+ entity_status?: EntityStatusDataUpdates[];
5543
5746
  };
5544
5747
  /** @returns {TransitionComments} */
5545
5748
  declare function TransitionComments(): TransitionComments;
@@ -6594,7 +6797,7 @@ type OrderDetails = {
6594
6797
  ordering_channel?: string;
6595
6798
  /**
6596
6799
  * - To uniquely identify the source
6597
- * through which order has been placed.
6800
+ * through which order has been placed (e.g, marketplace, gofynd).
6598
6801
  */
6599
6802
  ordering_source?: string;
6600
6803
  /**
@@ -9601,7 +9804,7 @@ type TransitionConfigCondition = {
9601
9804
  ordering_channel?: string;
9602
9805
  /**
9603
9806
  * - To uniquely identify the source
9604
- * through which order has been placed.
9807
+ * through which order has been placed (e.g, marketplace, gofynd).
9605
9808
  */
9606
9809
  ordering_source?: string;
9607
9810
  /**
@@ -10421,7 +10624,7 @@ type Address = {
10421
10624
  * - A unique identifier for the
10422
10625
  * delivery address.
10423
10626
  */
10424
- delivery_address_id?: string;
10627
+ delivery_address_id?: number;
10425
10628
  /**
10426
10629
  * - An object containing additional
10427
10630
  * geographical information related to the address.
@@ -11856,7 +12059,7 @@ type ShipmentItem = {
11856
12059
  order_date?: string;
11857
12060
  /**
11858
12061
  * - The timestamp indicating when the
11859
- * order was created.
12062
+ * order was created in UTC format.
11860
12063
  */
11861
12064
  order_created_ts?: string;
11862
12065
  shipment_status?: ShipmentStatus;
@@ -11868,7 +12071,7 @@ type ShipmentItem = {
11868
12071
  estimated_sla_time?: string;
11869
12072
  /**
11870
12073
  * - The timestamp for the estimated SLA,
11871
- * providing a specific time for expected delivery.
12074
+ * providing a specific time for expected delivery in UTC format.
11872
12075
  */
11873
12076
  estimated_sla_ts?: string;
11874
12077
  delivery_address?: Address;
@@ -11971,7 +12174,7 @@ type ShipmentItem = {
11971
12174
  ordering_channnel?: string;
11972
12175
  /**
11973
12176
  * - To uniquely identify the source
11974
- * through which order has been placed.
12177
+ * through which order has been placed (e.g, marketplace, gofynd).
11975
12178
  */
11976
12179
  ordering_source?: string;
11977
12180
  /**
@@ -12014,6 +12217,7 @@ type ShipmentItem = {
12014
12217
  * relevant metadata.
12015
12218
  */
12016
12219
  logistics_meta?: any;
12220
+ fulfillment_option?: FulfillmentOption;
12017
12221
  };
12018
12222
  /** @returns {ShipmentInternalPlatformViewResponseSchema} */
12019
12223
  declare function ShipmentInternalPlatformViewResponseSchema(): ShipmentInternalPlatformViewResponseSchema;
@@ -12188,7 +12392,7 @@ type OrderDetailsData = {
12188
12392
  ordering_channel?: string;
12189
12393
  /**
12190
12394
  * - To uniquely identify the source
12191
- * through which order has been placed.
12395
+ * through which order has been placed (e.g, marketplace, gofynd).
12192
12396
  */
12193
12397
  ordering_source?: string;
12194
12398
  /**
@@ -13448,9 +13652,18 @@ type ShipmentLockDetails = {
13448
13652
  */
13449
13653
  action_to_status?: any;
13450
13654
  };
13655
+ /** @returns {FulfillmentOption} */
13656
+ declare function FulfillmentOption(): FulfillmentOption;
13657
+ type FulfillmentOption = {
13658
+ name?: string;
13659
+ slug?: string;
13660
+ type?: string;
13661
+ is_default?: boolean;
13662
+ };
13451
13663
  /** @returns {PlatformShipment} */
13452
13664
  declare function PlatformShipment(): PlatformShipment;
13453
13665
  type PlatformShipment = {
13666
+ fulfillment_option?: FulfillmentOption;
13454
13667
  /**
13455
13668
  * - Indicates the date and time when the
13456
13669
  * shipment was physically picked up from the sender or the origin point by
@@ -13834,7 +14047,7 @@ type OrderData = {
13834
14047
  ordering_channel?: string;
13835
14048
  /**
13836
14049
  * - To uniquely identify the source
13837
- * through which order has been placed.
14050
+ * through which order has been placed (e.g, marketplace, gofynd).
13838
14051
  */
13839
14052
  ordering_source?: string;
13840
14053
  /**
@@ -14925,3 +15138,10 @@ type BulkFailedResponseSchema = {
14925
15138
  status?: boolean;
14926
15139
  error?: string;
14927
15140
  };
15141
+ /**
15142
+ * Enum: OrderingSource Used By: Order
15143
+ *
15144
+ * @returns {OrderingSource}
15145
+ */
15146
+ declare function OrderingSource(): OrderingSource;
15147
+ type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "gofynd" | "uniket" | "marketplace" | "social_commerce" | "ondc" | "nexus" | "nykaa_fashion" | "etsy" | "vuivui" | "zilingo" | "firstcry" | "bukalapak" | "myntra_ppmp" | "lazada" | "tiktok" | "sfcc" | "debenhams" | "prestomall" | "meesho" | "amazon_vdf" | "bigcommerce" | "sendo" | "storehippo" | "cdiscount" | "nykaa" | "trendyol" | "weloveshopping" | "jollee" | "wish" | "tiki" | "central_online" | "q10" | "cred" | "walmart" | "snapdeal" | "flipkart" | "blibli" | "ajio_jit" | "pharmeasy" | "ezmall" | "adobe_commerce" | "kartmax" | "shopee" | "zalora" | "prestashop" | "smytten" | "amazon_sc" | "urbanpiper" | "flipkart_quick" | "woocommerce" | "zivame" | "lelong" | "facebook" | "jiomart" | "gmc" | "robins" | "akulaku" | "noon" | "tatacliq" | "kartrocket" | "inorbit" | "ajio_business" | "swiggy" | "asos" | "tokopedia" | "limeroad" | "myntra_omni" | "spoyl" | "amazon_mlf" | "fulfilled_by_lazada" | "ebay" | "jd" | "amazon_pharmacy" | "ajio_vms" | "daraz" | "oker" | "flipkart_b2b" | "amazon_mlf_ss" | "woovly" | "tata1mg" | "zomato" | "shopify";