@gofynd/fdk-client-javascript 3.23.0 → 3.25.0

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 (38) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +12 -12
  4. package/sdk/application/Cart/CartApplicationClient.js +119 -33
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +1 -1
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +1 -1
  7. package/sdk/application/Common/CommonApplicationClient.js +1 -1
  8. package/sdk/application/Logistic/LogisticApplicationClient.js +4 -2
  9. package/sdk/application/Order/OrderApplicationClient.d.ts +1 -1
  10. package/sdk/application/Order/OrderApplicationClient.js +4 -0
  11. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +17 -17
  12. package/sdk/platform/Cart/CartPlatformApplicationClient.js +84 -13
  13. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -0
  14. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +52 -0
  15. package/sdk/platform/Cart/CartPlatformModel.d.ts +19 -27
  16. package/sdk/platform/Cart/CartPlatformModel.js +8 -18
  17. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +7 -2
  18. package/sdk/platform/Catalog/CatalogPlatformModel.js +5 -2
  19. package/sdk/platform/Common/CommonPlatformClient.js +1 -1
  20. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +96 -1
  21. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +61 -0
  22. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +48 -12
  23. package/sdk/platform/Content/ContentPlatformApplicationClient.js +316 -81
  24. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +27 -10
  25. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +38 -12
  26. package/sdk/platform/Content/ContentPlatformModel.d.ts +102 -1
  27. package/sdk/platform/Content/ContentPlatformModel.js +88 -0
  28. package/sdk/platform/Order/OrderPlatformClient.d.ts +28 -0
  29. package/sdk/platform/Order/OrderPlatformClient.js +179 -3
  30. package/sdk/platform/Order/OrderPlatformModel.d.ts +155 -6
  31. package/sdk/platform/Order/OrderPlatformModel.js +105 -3
  32. package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
  33. package/sdk/platform/Order/OrderPlatformValidator.js +30 -0
  34. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +63 -1
  35. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +43 -0
  36. package/sdk/platform/User/UserPlatformModel.d.ts +14 -1
  37. package/sdk/platform/User/UserPlatformModel.js +16 -0
  38. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
@@ -2773,8 +2773,8 @@ export = OrderPlatformModel;
2773
2773
  * @property {CPRiderDetailsSchema} [rider_details]
2774
2774
  * @property {boolean} [qc_supported] - Specifies that Assigned CP support's
2775
2775
  * quality checks
2776
- * @property {boolean} using_own_creds - Specifies weather the Seller's Creds or
2777
- * Fynd's Creds are being used.
2776
+ * @property {boolean} [using_own_creds] - Specifies weather the Seller's Creds
2777
+ * or Fynd's Creds are being used.
2778
2778
  * @property {number} [max_reattempts_for_delivery_allowed] - Reattempts Allowed
2779
2779
  * (required for NDR)
2780
2780
  * @property {CPTatToDeliverTheShipmentSchema} [tat_to_deliver_the_shipment]
@@ -2954,6 +2954,9 @@ export = OrderPlatformModel;
2954
2954
  /**
2955
2955
  * @typedef CPConfigurationSchema
2956
2956
  * @property {string} shipping_by - Shipping Handled by FYND or SELLER
2957
+ * @property {string} [logistics_by] - Specifies who manages the logistics
2958
+ * operations and how updates are handled. This determines the flow of
2959
+ * logistics information and responsibility for shipment management.
2957
2960
  */
2958
2961
  /**
2959
2962
  * @typedef ShippingDetailsSchema
@@ -3109,6 +3112,54 @@ export = OrderPlatformModel;
3109
3112
  * integration.
3110
3113
  * @property {Page} [page]
3111
3114
  */
3115
+ /**
3116
+ * @typedef TATSchema
3117
+ * @property {number} min - Specifies the minimum delivery promise timestamp (in
3118
+ * UNIX epoch), indicating the earliest time delivery can be completed.
3119
+ * @property {number} max - Specifies the maximum delivery promise timestamp (in
3120
+ * UNIX epoch), indicating the latest time by which delivery is expected to be
3121
+ * completed.
3122
+ */
3123
+ /**
3124
+ * @typedef ShipmentCourierPartnerPreference
3125
+ * @property {string} scheme_id - Unique identifier for the courier partner
3126
+ * scheme, used to fetch or modify scheme-specific details for the selected
3127
+ * courier partner.
3128
+ * @property {string} courier_partner_name - The human-readable name of the
3129
+ * courier partner that should be preferred when assigning a delivery partner
3130
+ * for the shipment.
3131
+ * @property {string} extension_id - Unique identifier of the courier partner
3132
+ * extension configured in the logistics system. This is used to identify the
3133
+ * courier partner whose preference is saved.
3134
+ * @property {string} [remarks] - Optional remarks or additional comments
3135
+ * provided by the user while saving the courier partner preference.
3136
+ * @property {TATSchema} tat
3137
+ */
3138
+ /**
3139
+ * @typedef ShipmentCourierPartnerRequestSchema
3140
+ * @property {string} scheme_id - Unique identifier for the courier partner
3141
+ * scheme, used to fetch or modify scheme-specific details for the selected
3142
+ * courier partner.
3143
+ * @property {string} courier_partner_name - The name of the courier partner
3144
+ * selected by the user while manually assigning the delivery partner for the shipment.
3145
+ * @property {string} extension_id - Unique identifier of the courier partner
3146
+ * extension configured in the logistics system. This is used to identify the
3147
+ * courier partner to be assigned.
3148
+ * @property {string} [remarks] - Optional remarks or additional comments
3149
+ * provided by the user while manually assigning the courier partner.
3150
+ * @property {TATSchema} tat
3151
+ */
3152
+ /**
3153
+ * @typedef CourierPartnerResponseSchema
3154
+ * @property {string} [message] - A human-readable message describing the
3155
+ * outcome of the operation.
3156
+ */
3157
+ /**
3158
+ * @typedef CourierPartnerErrorSchema
3159
+ * @property {string} [message] - A human-readable message explaining why the
3160
+ * request failed.
3161
+ * @property {string} [error] - A short description of the error.
3162
+ */
3112
3163
  /**
3113
3164
  * @typedef PackageProduct
3114
3165
  * @property {number} line_number - The line number of the product within the
@@ -5607,7 +5658,7 @@ export = OrderPlatformModel;
5607
5658
  declare class OrderPlatformModel {
5608
5659
  }
5609
5660
  declare namespace OrderPlatformModel {
5610
- export { PackageSchema, 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, RefundModeTransitionData, 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, FulfillmentOptionSchema, PaymentMethodGatewaySchema, SubModeOfPaymentSchema, PaymentMethodModeOfPaymentSchema, PaymentMethodTransactionPartySchema, LineItemPaymentMethodSchema, PackagesSchema, PackagesResponseSchema, PackagesErrorResponseSchema, BundleDetailsSchema, LineItemMonetaryValuesSchema, DimensionSchema, GiftDetailsSchema, CPRiderDetailsSchema, CPAreaCodeSchema, CPTatToDeliverTheShipmentSchema, CPOptionsSchema, CourierPartnerDetailsSchema, TaxDetailsSchema, PromiseDetailsSchema, CustomerPickupSlotSchema, DpPickupSlotSchema, OrderFulfillmentTimelineSchema, LineItemSchema, CreateOrderShipmentSchema, OrderingCurrencySchema, ConversionRateSchema, CurrencySchema, CouponOwnershipSchema, CouponSchema, BillingDetailsSchema, CPConfigurationSchema, ShippingDetailsSchema, UserDetailsSchema, LifecycleMessageSchema, CreateOrderRequestSchema, Page, OrderingSourceConfig, OrderingSourceFeature, ListOrderingSources, OrderingSourceSummary, CreateAccount, Account, AccountsList, PackageProduct, ValidationError, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, OrderingSourceDetails, UserDataInfo, BundleReturnConfig, BundleDetails, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, TaxComponent, SellerQcDetails, 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, LoyaltyDiscountDetails, 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, 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 };
5661
+ export { PackageSchema, 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, RefundModeTransitionData, 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, FulfillmentOptionSchema, PaymentMethodGatewaySchema, SubModeOfPaymentSchema, PaymentMethodModeOfPaymentSchema, PaymentMethodTransactionPartySchema, LineItemPaymentMethodSchema, PackagesSchema, PackagesResponseSchema, PackagesErrorResponseSchema, BundleDetailsSchema, LineItemMonetaryValuesSchema, DimensionSchema, GiftDetailsSchema, CPRiderDetailsSchema, CPAreaCodeSchema, CPTatToDeliverTheShipmentSchema, CPOptionsSchema, CourierPartnerDetailsSchema, TaxDetailsSchema, PromiseDetailsSchema, CustomerPickupSlotSchema, DpPickupSlotSchema, OrderFulfillmentTimelineSchema, LineItemSchema, CreateOrderShipmentSchema, OrderingCurrencySchema, ConversionRateSchema, CurrencySchema, CouponOwnershipSchema, CouponSchema, BillingDetailsSchema, CPConfigurationSchema, ShippingDetailsSchema, UserDetailsSchema, LifecycleMessageSchema, CreateOrderRequestSchema, Page, OrderingSourceConfig, OrderingSourceFeature, ListOrderingSources, OrderingSourceSummary, CreateAccount, Account, AccountsList, TATSchema, ShipmentCourierPartnerPreference, ShipmentCourierPartnerRequestSchema, CourierPartnerResponseSchema, CourierPartnerErrorSchema, PackageProduct, ValidationError, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, OrderingSourceDetails, UserDataInfo, BundleReturnConfig, BundleDetails, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, TaxComponent, SellerQcDetails, 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, LoyaltyDiscountDetails, 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, 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 };
5611
5662
  }
5612
5663
  /** @returns {PackageSchema} */
5613
5664
  declare function PackageSchema(): PackageSchema;
@@ -11189,10 +11240,10 @@ type CourierPartnerDetailsSchema = {
11189
11240
  */
11190
11241
  qc_supported?: boolean;
11191
11242
  /**
11192
- * - Specifies weather the Seller's Creds or
11193
- * Fynd's Creds are being used.
11243
+ * - Specifies weather the Seller's Creds
11244
+ * or Fynd's Creds are being used.
11194
11245
  */
11195
- using_own_creds: boolean;
11246
+ using_own_creds?: boolean;
11196
11247
  /**
11197
11248
  * - Reattempts Allowed
11198
11249
  * (required for NDR)
@@ -11581,6 +11632,12 @@ type CPConfigurationSchema = {
11581
11632
  * - Shipping Handled by FYND or SELLER
11582
11633
  */
11583
11634
  shipping_by: string;
11635
+ /**
11636
+ * - Specifies who manages the logistics
11637
+ * operations and how updates are handled. This determines the flow of
11638
+ * logistics information and responsibility for shipment management.
11639
+ */
11640
+ logistics_by?: string;
11584
11641
  };
11585
11642
  /** @returns {ShippingDetailsSchema} */
11586
11643
  declare function ShippingDetailsSchema(): ShippingDetailsSchema;
@@ -11946,6 +12003,98 @@ type AccountsList = {
11946
12003
  data?: Account[];
11947
12004
  page?: Page;
11948
12005
  };
12006
+ /** @returns {TATSchema} */
12007
+ declare function TATSchema(): TATSchema;
12008
+ type TATSchema = {
12009
+ /**
12010
+ * - Specifies the minimum delivery promise timestamp (in
12011
+ * UNIX epoch), indicating the earliest time delivery can be completed.
12012
+ */
12013
+ min: number;
12014
+ /**
12015
+ * - Specifies the maximum delivery promise timestamp (in
12016
+ * UNIX epoch), indicating the latest time by which delivery is expected to be
12017
+ * completed.
12018
+ */
12019
+ max: number;
12020
+ };
12021
+ /** @returns {ShipmentCourierPartnerPreference} */
12022
+ declare function ShipmentCourierPartnerPreference(): ShipmentCourierPartnerPreference;
12023
+ type ShipmentCourierPartnerPreference = {
12024
+ /**
12025
+ * - Unique identifier for the courier partner
12026
+ * scheme, used to fetch or modify scheme-specific details for the selected
12027
+ * courier partner.
12028
+ */
12029
+ scheme_id: string;
12030
+ /**
12031
+ * - The human-readable name of the
12032
+ * courier partner that should be preferred when assigning a delivery partner
12033
+ * for the shipment.
12034
+ */
12035
+ courier_partner_name: string;
12036
+ /**
12037
+ * - Unique identifier of the courier partner
12038
+ * extension configured in the logistics system. This is used to identify the
12039
+ * courier partner whose preference is saved.
12040
+ */
12041
+ extension_id: string;
12042
+ /**
12043
+ * - Optional remarks or additional comments
12044
+ * provided by the user while saving the courier partner preference.
12045
+ */
12046
+ remarks?: string;
12047
+ tat: TATSchema;
12048
+ };
12049
+ /** @returns {ShipmentCourierPartnerRequestSchema} */
12050
+ declare function ShipmentCourierPartnerRequestSchema(): ShipmentCourierPartnerRequestSchema;
12051
+ type ShipmentCourierPartnerRequestSchema = {
12052
+ /**
12053
+ * - Unique identifier for the courier partner
12054
+ * scheme, used to fetch or modify scheme-specific details for the selected
12055
+ * courier partner.
12056
+ */
12057
+ scheme_id: string;
12058
+ /**
12059
+ * - The name of the courier partner
12060
+ * selected by the user while manually assigning the delivery partner for the shipment.
12061
+ */
12062
+ courier_partner_name: string;
12063
+ /**
12064
+ * - Unique identifier of the courier partner
12065
+ * extension configured in the logistics system. This is used to identify the
12066
+ * courier partner to be assigned.
12067
+ */
12068
+ extension_id: string;
12069
+ /**
12070
+ * - Optional remarks or additional comments
12071
+ * provided by the user while manually assigning the courier partner.
12072
+ */
12073
+ remarks?: string;
12074
+ tat: TATSchema;
12075
+ };
12076
+ /** @returns {CourierPartnerResponseSchema} */
12077
+ declare function CourierPartnerResponseSchema(): CourierPartnerResponseSchema;
12078
+ type CourierPartnerResponseSchema = {
12079
+ /**
12080
+ * - A human-readable message describing the
12081
+ * outcome of the operation.
12082
+ */
12083
+ message?: string;
12084
+ };
12085
+ /** @returns {CourierPartnerErrorSchema} */
12086
+ declare function CourierPartnerErrorSchema(): CourierPartnerErrorSchema;
12087
+ type CourierPartnerErrorSchema = {
12088
+ /**
12089
+ * - A human-readable message explaining why the
12090
+ * request failed.
12091
+ */
12092
+ message?: string;
12093
+ /**
12094
+ * - A short description of the error.
12095
+ */
12096
+ error?: string;
12097
+ };
11949
12098
  /** @returns {PackageProduct} */
11950
12099
  declare function PackageProduct(): PackageProduct;
11951
12100
  type PackageProduct = {
@@ -3025,8 +3025,8 @@ const Joi = require("joi");
3025
3025
  * @property {CPRiderDetailsSchema} [rider_details]
3026
3026
  * @property {boolean} [qc_supported] - Specifies that Assigned CP support's
3027
3027
  * quality checks
3028
- * @property {boolean} using_own_creds - Specifies weather the Seller's Creds or
3029
- * Fynd's Creds are being used.
3028
+ * @property {boolean} [using_own_creds] - Specifies weather the Seller's Creds
3029
+ * or Fynd's Creds are being used.
3030
3030
  * @property {number} [max_reattempts_for_delivery_allowed] - Reattempts Allowed
3031
3031
  * (required for NDR)
3032
3032
  * @property {CPTatToDeliverTheShipmentSchema} [tat_to_deliver_the_shipment]
@@ -3220,6 +3220,9 @@ const Joi = require("joi");
3220
3220
  /**
3221
3221
  * @typedef CPConfigurationSchema
3222
3222
  * @property {string} shipping_by - Shipping Handled by FYND or SELLER
3223
+ * @property {string} [logistics_by] - Specifies who manages the logistics
3224
+ * operations and how updates are handled. This determines the flow of
3225
+ * logistics information and responsibility for shipment management.
3223
3226
  */
3224
3227
 
3225
3228
  /**
@@ -3388,6 +3391,59 @@ const Joi = require("joi");
3388
3391
  * @property {Page} [page]
3389
3392
  */
3390
3393
 
3394
+ /**
3395
+ * @typedef TATSchema
3396
+ * @property {number} min - Specifies the minimum delivery promise timestamp (in
3397
+ * UNIX epoch), indicating the earliest time delivery can be completed.
3398
+ * @property {number} max - Specifies the maximum delivery promise timestamp (in
3399
+ * UNIX epoch), indicating the latest time by which delivery is expected to be
3400
+ * completed.
3401
+ */
3402
+
3403
+ /**
3404
+ * @typedef ShipmentCourierPartnerPreference
3405
+ * @property {string} scheme_id - Unique identifier for the courier partner
3406
+ * scheme, used to fetch or modify scheme-specific details for the selected
3407
+ * courier partner.
3408
+ * @property {string} courier_partner_name - The human-readable name of the
3409
+ * courier partner that should be preferred when assigning a delivery partner
3410
+ * for the shipment.
3411
+ * @property {string} extension_id - Unique identifier of the courier partner
3412
+ * extension configured in the logistics system. This is used to identify the
3413
+ * courier partner whose preference is saved.
3414
+ * @property {string} [remarks] - Optional remarks or additional comments
3415
+ * provided by the user while saving the courier partner preference.
3416
+ * @property {TATSchema} tat
3417
+ */
3418
+
3419
+ /**
3420
+ * @typedef ShipmentCourierPartnerRequestSchema
3421
+ * @property {string} scheme_id - Unique identifier for the courier partner
3422
+ * scheme, used to fetch or modify scheme-specific details for the selected
3423
+ * courier partner.
3424
+ * @property {string} courier_partner_name - The name of the courier partner
3425
+ * selected by the user while manually assigning the delivery partner for the shipment.
3426
+ * @property {string} extension_id - Unique identifier of the courier partner
3427
+ * extension configured in the logistics system. This is used to identify the
3428
+ * courier partner to be assigned.
3429
+ * @property {string} [remarks] - Optional remarks or additional comments
3430
+ * provided by the user while manually assigning the courier partner.
3431
+ * @property {TATSchema} tat
3432
+ */
3433
+
3434
+ /**
3435
+ * @typedef CourierPartnerResponseSchema
3436
+ * @property {string} [message] - A human-readable message describing the
3437
+ * outcome of the operation.
3438
+ */
3439
+
3440
+ /**
3441
+ * @typedef CourierPartnerErrorSchema
3442
+ * @property {string} [message] - A human-readable message explaining why the
3443
+ * request failed.
3444
+ * @property {string} [error] - A short description of the error.
3445
+ */
3446
+
3391
3447
  /**
3392
3448
  * @typedef PackageProduct
3393
3449
  * @property {number} line_number - The line number of the product within the
@@ -8824,7 +8880,7 @@ class OrderPlatformModel {
8824
8880
  extension_id: Joi.string().allow("").required(),
8825
8881
  rider_details: OrderPlatformModel.CPRiderDetailsSchema(),
8826
8882
  qc_supported: Joi.boolean(),
8827
- using_own_creds: Joi.boolean().required(),
8883
+ using_own_creds: Joi.boolean(),
8828
8884
  max_reattempts_for_delivery_allowed: Joi.number(),
8829
8885
  tat_to_deliver_the_shipment: OrderPlatformModel.CPTatToDeliverTheShipmentSchema(),
8830
8886
  is_self_ship: Joi.boolean(),
@@ -9000,6 +9056,7 @@ class OrderPlatformModel {
9000
9056
  static CPConfigurationSchema() {
9001
9057
  return Joi.object({
9002
9058
  shipping_by: Joi.string().allow("").required(),
9059
+ logistics_by: Joi.string().allow(""),
9003
9060
  });
9004
9061
  }
9005
9062
 
@@ -9158,6 +9215,51 @@ class OrderPlatformModel {
9158
9215
  });
9159
9216
  }
9160
9217
 
9218
+ /** @returns {TATSchema} */
9219
+ static TATSchema() {
9220
+ return Joi.object({
9221
+ min: Joi.number().required(),
9222
+ max: Joi.number().required(),
9223
+ });
9224
+ }
9225
+
9226
+ /** @returns {ShipmentCourierPartnerPreference} */
9227
+ static ShipmentCourierPartnerPreference() {
9228
+ return Joi.object({
9229
+ scheme_id: Joi.string().allow("").required(),
9230
+ courier_partner_name: Joi.string().allow("").required(),
9231
+ extension_id: Joi.string().allow("").required(),
9232
+ remarks: Joi.string().allow(""),
9233
+ tat: OrderPlatformModel.TATSchema().required(),
9234
+ });
9235
+ }
9236
+
9237
+ /** @returns {ShipmentCourierPartnerRequestSchema} */
9238
+ static ShipmentCourierPartnerRequestSchema() {
9239
+ return Joi.object({
9240
+ scheme_id: Joi.string().allow("").required(),
9241
+ courier_partner_name: Joi.string().allow("").required(),
9242
+ extension_id: Joi.string().allow("").required(),
9243
+ remarks: Joi.string().allow(""),
9244
+ tat: OrderPlatformModel.TATSchema().required(),
9245
+ });
9246
+ }
9247
+
9248
+ /** @returns {CourierPartnerResponseSchema} */
9249
+ static CourierPartnerResponseSchema() {
9250
+ return Joi.object({
9251
+ message: Joi.string().allow(""),
9252
+ });
9253
+ }
9254
+
9255
+ /** @returns {CourierPartnerErrorSchema} */
9256
+ static CourierPartnerErrorSchema() {
9257
+ return Joi.object({
9258
+ message: Joi.string().allow(""),
9259
+ error: Joi.string().allow(""),
9260
+ });
9261
+ }
9262
+
9161
9263
  /** @returns {PackageProduct} */
9162
9264
  static PackageProduct() {
9163
9265
  return Joi.object({
@@ -457,6 +457,18 @@ export = OrderPlatformValidator;
457
457
  * @typedef ReassignLocationParam
458
458
  * @property {OrderPlatformModel.StoreReassign} body
459
459
  */
460
+ /**
461
+ * @typedef RequestCourierPartnerForShipmentParam
462
+ * @property {string} shipmentId - The unique identifier for the shipment. This
463
+ * ID is used to track and reference the shipment throughout its journey.
464
+ * @property {OrderPlatformModel.ShipmentCourierPartnerRequestSchema} body
465
+ */
466
+ /**
467
+ * @typedef SaveCourierPartnerPreferenceForShipmentParam
468
+ * @property {string} shipmentId - The unique identifier for the shipment. This
469
+ * ID is used to track and reference the shipment throughout its journey.
470
+ * @property {OrderPlatformModel.ShipmentCourierPartnerPreference} body
471
+ */
460
472
  /**
461
473
  * @typedef SendSmsNinjaParam
462
474
  * @property {OrderPlatformModel.SendSmsPayload} body
@@ -619,6 +631,10 @@ declare class OrderPlatformValidator {
619
631
  static postShipmentHistory(): PostShipmentHistoryParam;
620
632
  /** @returns {ReassignLocationParam} */
621
633
  static reassignLocation(): ReassignLocationParam;
634
+ /** @returns {RequestCourierPartnerForShipmentParam} */
635
+ static requestCourierPartnerForShipment(): RequestCourierPartnerForShipmentParam;
636
+ /** @returns {SaveCourierPartnerPreferenceForShipmentParam} */
637
+ static saveCourierPartnerPreferenceForShipment(): SaveCourierPartnerPreferenceForShipmentParam;
622
638
  /** @returns {SendSmsNinjaParam} */
623
639
  static sendSmsNinja(): SendSmsNinjaParam;
624
640
  /** @returns {SendUserMobileOTPParam} */
@@ -647,7 +663,7 @@ declare class OrderPlatformValidator {
647
663
  static verifyMobileOTP(): VerifyMobileOTPParam;
648
664
  }
649
665
  declare namespace OrderPlatformValidator {
650
- export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateAccountParam, CreateChannelConfigParam, CreateOrderParam, CreateShipmentPackagesParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FailedOrderLogsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAccountByIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentPackagesParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, JobDetailsParam, ListAccountsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAccountParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentPackagesParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
666
+ export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateAccountParam, CreateChannelConfigParam, CreateOrderParam, CreateShipmentPackagesParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FailedOrderLogsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAccountByIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentPackagesParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, JobDetailsParam, ListAccountsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, RequestCourierPartnerForShipmentParam, SaveCourierPartnerPreferenceForShipmentParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAccountParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentPackagesParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
651
667
  }
652
668
  type AddStateManagerConfigParam = {
653
669
  body: OrderPlatformModel.TransitionConfigPayload;
@@ -1572,6 +1588,22 @@ type PostShipmentHistoryParam = {
1572
1588
  type ReassignLocationParam = {
1573
1589
  body: OrderPlatformModel.StoreReassign;
1574
1590
  };
1591
+ type RequestCourierPartnerForShipmentParam = {
1592
+ /**
1593
+ * - The unique identifier for the shipment. This
1594
+ * ID is used to track and reference the shipment throughout its journey.
1595
+ */
1596
+ shipmentId: string;
1597
+ body: OrderPlatformModel.ShipmentCourierPartnerRequestSchema;
1598
+ };
1599
+ type SaveCourierPartnerPreferenceForShipmentParam = {
1600
+ /**
1601
+ * - The unique identifier for the shipment. This
1602
+ * ID is used to track and reference the shipment throughout its journey.
1603
+ */
1604
+ shipmentId: string;
1605
+ body: OrderPlatformModel.ShipmentCourierPartnerPreference;
1606
+ };
1575
1607
  type SendSmsNinjaParam = {
1576
1608
  body: OrderPlatformModel.SendSmsPayload;
1577
1609
  };
@@ -511,6 +511,20 @@ const OrderPlatformModel = require("./OrderPlatformModel");
511
511
  * @property {OrderPlatformModel.StoreReassign} body
512
512
  */
513
513
 
514
+ /**
515
+ * @typedef RequestCourierPartnerForShipmentParam
516
+ * @property {string} shipmentId - The unique identifier for the shipment. This
517
+ * ID is used to track and reference the shipment throughout its journey.
518
+ * @property {OrderPlatformModel.ShipmentCourierPartnerRequestSchema} body
519
+ */
520
+
521
+ /**
522
+ * @typedef SaveCourierPartnerPreferenceForShipmentParam
523
+ * @property {string} shipmentId - The unique identifier for the shipment. This
524
+ * ID is used to track and reference the shipment throughout its journey.
525
+ * @property {OrderPlatformModel.ShipmentCourierPartnerPreference} body
526
+ */
527
+
514
528
  /**
515
529
  * @typedef SendSmsNinjaParam
516
530
  * @property {OrderPlatformModel.SendSmsPayload} body
@@ -1092,6 +1106,22 @@ class OrderPlatformValidator {
1092
1106
  }).required();
1093
1107
  }
1094
1108
 
1109
+ /** @returns {RequestCourierPartnerForShipmentParam} */
1110
+ static requestCourierPartnerForShipment() {
1111
+ return Joi.object({
1112
+ shipmentId: Joi.string().allow("").required(),
1113
+ body: OrderPlatformModel.ShipmentCourierPartnerRequestSchema().required(),
1114
+ }).required();
1115
+ }
1116
+
1117
+ /** @returns {SaveCourierPartnerPreferenceForShipmentParam} */
1118
+ static saveCourierPartnerPreferenceForShipment() {
1119
+ return Joi.object({
1120
+ shipmentId: Joi.string().allow("").required(),
1121
+ body: OrderPlatformModel.ShipmentCourierPartnerPreference().required(),
1122
+ }).required();
1123
+ }
1124
+
1095
1125
  /** @returns {SendSmsNinjaParam} */
1096
1126
  static sendSmsNinja() {
1097
1127
  return Joi.object({
@@ -52,6 +52,7 @@ export = ServiceabilityPlatformModel;
52
52
  * @property {boolean} [is_default] - Whether this is the default fulfillment option.
53
53
  * @property {string} [type] - Type of fulfillment option.
54
54
  * @property {string} [status] - Status of the fulfillment option.
55
+ * @property {FulfillmentOptionDefaultFor} [default_for]
55
56
  * @property {BusinessUnit[]} [business_unit] - Name of the ordering-channel or
56
57
  * business, e.g. storefront, storeos.
57
58
  * @property {FulfillmentStores} [fulfillment_stores]
@@ -177,6 +178,7 @@ export = ServiceabilityPlatformModel;
177
178
  * @property {ListViewItems[]} items - List of zone items, each representing a
178
179
  * zone's details.
179
180
  * @property {Page} page
181
+ * @property {FoDetails} [fo_details]
180
182
  */
181
183
  /**
182
184
  * @typedef GetZoneByIdSchema
@@ -1303,6 +1305,9 @@ export = ServiceabilityPlatformModel;
1303
1305
  * in the courier partner shipment.
1304
1306
  * @property {boolean} is_mto - A boolean indicating if the courier partner
1305
1307
  * supports Made to Order service.
1308
+ * @property {boolean} [is_mps] - Indicates if shipment configuration is
1309
+ * multi-part shipment or single shipment.
1310
+ * @property {boolean} [is_b2b] - Indicates if the shipment is business-to-business.
1306
1311
  * @property {string[]} ignore_scheme_ids - A list of scheme_id which we want to
1307
1312
  * ignore in courier_partner assignment.
1308
1313
  * @property {Object} [error] - Error Details
@@ -1680,6 +1685,13 @@ export = ServiceabilityPlatformModel;
1680
1685
  * @property {number} [non_qc_shipment_item_quantity] - Quantity of items not
1681
1686
  * under quality control (nullable).
1682
1687
  */
1688
+ /**
1689
+ * @typedef FulfillmentOptionDefaultFor
1690
+ * @property {boolean} [storefront] - If set to true, this fulfillment option
1691
+ * will be default for storefront.
1692
+ * @property {boolean} [storeos] - If set to true, this fulfillment option will
1693
+ * be default for storeos.
1694
+ */
1683
1695
  /**
1684
1696
  * @typedef BusinessUnit
1685
1697
  * @property {string} [name] - Name of the business unit.
@@ -1966,6 +1978,15 @@ export = ServiceabilityPlatformModel;
1966
1978
  * @property {string} [name] - Name of the region.
1967
1979
  * @property {number} [count] - Count of items in the region.
1968
1980
  */
1981
+ /**
1982
+ * @typedef FoDetails
1983
+ * @property {string} serviceability_type - Serviceability strategy configured
1984
+ * for the fulfillment option. `zone_based` corresponds to the "Restrict to
1985
+ * Zones" strategy and `all` to "Ship to All".
1986
+ * @property {number} active_non_default_zone_count - Number of active,
1987
+ * non-default zones (excluding zones still in progress) mapped to this
1988
+ * fulfillment option.
1989
+ */
1969
1990
  /**
1970
1991
  * @typedef ZoneStores
1971
1992
  * @property {Object} type - Type of zone store.
@@ -2879,7 +2900,7 @@ export = ServiceabilityPlatformModel;
2879
2900
  declare class ServiceabilityPlatformModel {
2880
2901
  }
2881
2902
  declare namespace ServiceabilityPlatformModel {
2882
- export { GenerateShipmentsAndCourierPartnerResult, CourierPartnerDetails, PlatformShipmentsRequestSchema, PlatformShipmentsResponseSchema, ShipmentsErrorResult, FulfillmentOption, FulfillmentOptionsList, FulfillmentOptionProducts, FulfillmentOptionStores, FulfillmentOptionBulkValidate, FulfillmentOptionBulkValidateData, FulfillmentOptionBulk, FulfillmentOptionBulkData, OperationResponseSchema, SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, StorePolygonServiceabilityRequestBody, StorePolygonServiceabilityResult, StorePolygonServiceabilityGetResult, ZoneProductsBulkPatchDetails, GetZoneProductsBulkPatchResult, CourierPartnerToServiceability, ServiceabilityLocation, CourierPartnerShipments, PromiseObject, PromiseData, PromiseMeta, CourierPartnerPromiseData, DeliveryTat, DeliveryTatSchema, CourierPartnerShipmentsMeta, ShipmentCourierPartnersResult, AreaCode, TAT, LocationDetailsServiceability, CourierPartnerShipmentsArticles, CourierPartnerArticlesPromise, CourierPartnerArticlesReturnReasons, CourierPartnerArticlesReturnReasonsMeta, ArticleWeight, ArticleAttributes, ArticleDimension, PlatformLocationArticles, PlatformLocationArticle, ParentItemIdentifiers, PlatformShipmentsToServiceability, PlatformShipmentsSchema, Packaging, Dimension, FulfillmentOptionItem, ShipmentsPromise, CustomerPromise, ShipmentPromiseMeta, SellerPromise, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, CustomerInitialPromise, ShipmentsArticle, ShipmentDimension, ShipmentsMeta, ShipmentsCourierPartner, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, LatLong, StoreDistance, StoreTimingDetails, StoreTiming, Time, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, DateOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentsArticles, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject, StorePolygonServiceabilityRequestData, StorePolygonServiceabilityStore, StorePolygonServiceabilityStoreCoordinates, StorePolygonServiceabilityConfig, StorePolygonServiceabilityPolygon, StorePolygonServiceabilityFeature, StorePolygonServiceabilityGeometry, StorePolygonServiceabilityAttributes, StorePolygonServiceabilityReferenceCoordinates, StorePolygonServiceabilityStoreSummary, StorePolygonServiceabilityError, StorePolygonServiceabilityPagination };
2903
+ export { GenerateShipmentsAndCourierPartnerResult, CourierPartnerDetails, PlatformShipmentsRequestSchema, PlatformShipmentsResponseSchema, ShipmentsErrorResult, FulfillmentOption, FulfillmentOptionsList, FulfillmentOptionProducts, FulfillmentOptionStores, FulfillmentOptionBulkValidate, FulfillmentOptionBulkValidateData, FulfillmentOptionBulk, FulfillmentOptionBulkData, OperationResponseSchema, SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, StorePolygonServiceabilityRequestBody, StorePolygonServiceabilityResult, StorePolygonServiceabilityGetResult, ZoneProductsBulkPatchDetails, GetZoneProductsBulkPatchResult, CourierPartnerToServiceability, ServiceabilityLocation, CourierPartnerShipments, PromiseObject, PromiseData, PromiseMeta, CourierPartnerPromiseData, DeliveryTat, DeliveryTatSchema, CourierPartnerShipmentsMeta, ShipmentCourierPartnersResult, AreaCode, TAT, LocationDetailsServiceability, CourierPartnerShipmentsArticles, CourierPartnerArticlesPromise, CourierPartnerArticlesReturnReasons, CourierPartnerArticlesReturnReasonsMeta, ArticleWeight, ArticleAttributes, ArticleDimension, PlatformLocationArticles, PlatformLocationArticle, ParentItemIdentifiers, PlatformShipmentsToServiceability, PlatformShipmentsSchema, Packaging, Dimension, FulfillmentOptionItem, ShipmentsPromise, CustomerPromise, ShipmentPromiseMeta, SellerPromise, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, CustomerInitialPromise, ShipmentsArticle, ShipmentDimension, ShipmentsMeta, ShipmentsCourierPartner, FulfillmentOptionDefaultFor, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, LatLong, StoreDistance, StoreTimingDetails, StoreTiming, Time, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, FoDetails, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, DateOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentsArticles, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject, StorePolygonServiceabilityRequestData, StorePolygonServiceabilityStore, StorePolygonServiceabilityStoreCoordinates, StorePolygonServiceabilityConfig, StorePolygonServiceabilityPolygon, StorePolygonServiceabilityFeature, StorePolygonServiceabilityGeometry, StorePolygonServiceabilityAttributes, StorePolygonServiceabilityReferenceCoordinates, StorePolygonServiceabilityStoreSummary, StorePolygonServiceabilityError, StorePolygonServiceabilityPagination };
2883
2904
  }
2884
2905
  /** @returns {GenerateShipmentsAndCourierPartnerResult} */
2885
2906
  declare function GenerateShipmentsAndCourierPartnerResult(): GenerateShipmentsAndCourierPartnerResult;
@@ -3015,6 +3036,7 @@ type FulfillmentOption = {
3015
3036
  * - Status of the fulfillment option.
3016
3037
  */
3017
3038
  status?: string;
3039
+ default_for?: FulfillmentOptionDefaultFor;
3018
3040
  /**
3019
3041
  * - Name of the ordering-channel or
3020
3042
  * business, e.g. storefront, storeos.
@@ -3314,6 +3336,7 @@ type ListViewSchema = {
3314
3336
  */
3315
3337
  items: ListViewItems[];
3316
3338
  page: Page;
3339
+ fo_details?: FoDetails;
3317
3340
  };
3318
3341
  /** @returns {GetZoneByIdSchema} */
3319
3342
  declare function GetZoneByIdSchema(): GetZoneByIdSchema;
@@ -6113,6 +6136,15 @@ type CourierPartnerShipments = {
6113
6136
  * supports Made to Order service.
6114
6137
  */
6115
6138
  is_mto: boolean;
6139
+ /**
6140
+ * - Indicates if shipment configuration is
6141
+ * multi-part shipment or single shipment.
6142
+ */
6143
+ is_mps?: boolean;
6144
+ /**
6145
+ * - Indicates if the shipment is business-to-business.
6146
+ */
6147
+ is_b2b?: boolean;
6116
6148
  /**
6117
6149
  * - A list of scheme_id which we want to
6118
6150
  * ignore in courier_partner assignment.
@@ -7071,6 +7103,20 @@ type ShipmentsCourierPartner = {
7071
7103
  */
7072
7104
  non_qc_shipment_item_quantity?: number;
7073
7105
  };
7106
+ /** @returns {FulfillmentOptionDefaultFor} */
7107
+ declare function FulfillmentOptionDefaultFor(): FulfillmentOptionDefaultFor;
7108
+ type FulfillmentOptionDefaultFor = {
7109
+ /**
7110
+ * - If set to true, this fulfillment option
7111
+ * will be default for storefront.
7112
+ */
7113
+ storefront?: boolean;
7114
+ /**
7115
+ * - If set to true, this fulfillment option will
7116
+ * be default for storeos.
7117
+ */
7118
+ storeos?: boolean;
7119
+ };
7074
7120
  /** @returns {BusinessUnit} */
7075
7121
  declare function BusinessUnit(): BusinessUnit;
7076
7122
  type BusinessUnit = {
@@ -7836,6 +7882,22 @@ type RegionSchema = {
7836
7882
  */
7837
7883
  count?: number;
7838
7884
  };
7885
+ /** @returns {FoDetails} */
7886
+ declare function FoDetails(): FoDetails;
7887
+ type FoDetails = {
7888
+ /**
7889
+ * - Serviceability strategy configured
7890
+ * for the fulfillment option. `zone_based` corresponds to the "Restrict to
7891
+ * Zones" strategy and `all` to "Ship to All".
7892
+ */
7893
+ serviceability_type: string;
7894
+ /**
7895
+ * - Number of active,
7896
+ * non-default zones (excluding zones still in progress) mapped to this
7897
+ * fulfillment option.
7898
+ */
7899
+ active_non_default_zone_count: number;
7900
+ };
7839
7901
  /** @returns {ZoneStores} */
7840
7902
  declare function ZoneStores(): ZoneStores;
7841
7903
  type ZoneStores = {