@gofynd/fdk-client-javascript 3.4.0 → 3.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -26
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +3 -2
- package/sdk/application/ApplicationClient.js +25 -19
- package/sdk/common/utils.js +6 -3
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +111 -43
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +65 -33
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/platform/Cart/CartPlatformModel.d.ts +181 -10
- package/sdk/platform/Cart/CartPlatformModel.js +95 -8
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +40 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +260 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +68 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +49 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +26 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +27 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +14 -19
- package/sdk/platform/Content/ContentPlatformModel.js +6 -20
- package/sdk/platform/Order/OrderPlatformModel.d.ts +218 -17
- package/sdk/platform/Order/OrderPlatformModel.js +366 -14
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +15 -15
- package/sdk/platform/Order/OrderPlatformValidator.js +9 -9
- package/sdk/platform/PlatformClient.d.ts +5 -2
- package/sdk/platform/PlatformClient.js +32 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +50 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +22 -2
- package/sdk/public/PublicClient.d.ts +3 -2
- package/sdk/public/PublicClient.js +13 -7
|
@@ -375,6 +375,7 @@ export = CompanyProfilePlatformModel;
|
|
|
375
375
|
* @property {AverageOrderProcessingTime} [avg_order_processing_time]
|
|
376
376
|
* @property {boolean} [bulk_shipment]
|
|
377
377
|
* @property {boolean} [auto_assign_courier_partner]
|
|
378
|
+
* @property {boolean} [qc_based_return_inventory_sync]
|
|
378
379
|
*/
|
|
379
380
|
/**
|
|
380
381
|
* @typedef LocationListSchema
|
|
@@ -892,6 +893,7 @@ type GetLocationSchema = {
|
|
|
892
893
|
avg_order_processing_time?: AverageOrderProcessingTime;
|
|
893
894
|
bulk_shipment?: boolean;
|
|
894
895
|
auto_assign_courier_partner?: boolean;
|
|
896
|
+
qc_based_return_inventory_sync?: boolean;
|
|
895
897
|
};
|
|
896
898
|
/** @returns {LocationListSchema} */
|
|
897
899
|
declare function LocationListSchema(): LocationListSchema;
|
|
@@ -414,6 +414,7 @@ const Joi = require("joi");
|
|
|
414
414
|
* @property {AverageOrderProcessingTime} [avg_order_processing_time]
|
|
415
415
|
* @property {boolean} [bulk_shipment]
|
|
416
416
|
* @property {boolean} [auto_assign_courier_partner]
|
|
417
|
+
* @property {boolean} [qc_based_return_inventory_sync]
|
|
417
418
|
*/
|
|
418
419
|
|
|
419
420
|
/**
|
|
@@ -1002,6 +1003,7 @@ class CompanyProfilePlatformModel {
|
|
|
1002
1003
|
avg_order_processing_time: CompanyProfilePlatformModel.AverageOrderProcessingTime(),
|
|
1003
1004
|
bulk_shipment: Joi.boolean(),
|
|
1004
1005
|
auto_assign_courier_partner: Joi.boolean(),
|
|
1006
|
+
qc_based_return_inventory_sync: Joi.boolean(),
|
|
1005
1007
|
});
|
|
1006
1008
|
}
|
|
1007
1009
|
|
|
@@ -1438,12 +1438,7 @@ export = ContentPlatformModel;
|
|
|
1438
1438
|
* @typedef ResourceTranslation
|
|
1439
1439
|
* @property {string} [_id] - Unique identifier for the translation entry
|
|
1440
1440
|
* @property {string} [locale] - Language code for this translation
|
|
1441
|
-
* @property {
|
|
1442
|
-
*/
|
|
1443
|
-
/**
|
|
1444
|
-
* @typedef TranslationValue
|
|
1445
|
-
* @property {string} [name] - Translated name
|
|
1446
|
-
* @property {TranslationSeo} [seo]
|
|
1441
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1447
1442
|
*/
|
|
1448
1443
|
/**
|
|
1449
1444
|
* @typedef TranslationSeo
|
|
@@ -1462,11 +1457,11 @@ export = ContentPlatformModel;
|
|
|
1462
1457
|
* @property {string} [type] - Type of content being translated
|
|
1463
1458
|
* @property {string} [resource_id] - Identifier of the resource requiring translation
|
|
1464
1459
|
* @property {string} [locale] - Target language code for the translation
|
|
1465
|
-
* @property {
|
|
1460
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1466
1461
|
*/
|
|
1467
1462
|
/**
|
|
1468
1463
|
* @typedef ResourceTranslationUpdate
|
|
1469
|
-
* @property {
|
|
1464
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1470
1465
|
*/
|
|
1471
1466
|
/**
|
|
1472
1467
|
* @typedef TranslatableSection
|
|
@@ -1562,7 +1557,7 @@ export = ContentPlatformModel;
|
|
|
1562
1557
|
declare class ContentPlatformModel {
|
|
1563
1558
|
}
|
|
1564
1559
|
declare namespace ContentPlatformModel {
|
|
1565
|
-
export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, TranslateUiLabels, TranslateUiLabelsCreate, StaticResourceUpdate, TranslateUiLabelsPage, Error, Meta, CompanyLanguage, CompanyLanguageCreate, CompanyLanguageUpdate, ApplicationLanguage, unPublishApplicationLanguage, ApplicationLanguageCreate, ApplicationLanguageUpdate, TranslatableResource, ResourceDefinition, ResourceJsonSchema, ResourceJsonSchemaType, ResourceUISchema, ResourceBulkDetails, Title, FeatureImage, Seo, MetaTag, MetaTagItem, ResourceTranslation,
|
|
1560
|
+
export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, TranslateUiLabels, TranslateUiLabelsCreate, StaticResourceUpdate, TranslateUiLabelsPage, Error, Meta, CompanyLanguage, CompanyLanguageCreate, CompanyLanguageUpdate, ApplicationLanguage, unPublishApplicationLanguage, ApplicationLanguageCreate, ApplicationLanguageUpdate, TranslatableResource, ResourceDefinition, ResourceJsonSchema, ResourceJsonSchemaType, ResourceUISchema, ResourceBulkDetails, Title, FeatureImage, Seo, MetaTag, MetaTagItem, ResourceTranslation, TranslationSeo, ResourceTranslationList, ResourceTranslationCreate, ResourceTranslationUpdate, TranslatableSection, Metrics, ResourceTranslationUpsertItem, ResourceTranslationBulkUpsert, StandardError, OperationResponseSchema, GenerationEntityType, PageType };
|
|
1566
1561
|
}
|
|
1567
1562
|
/** @returns {ValidationError} */
|
|
1568
1563
|
declare function ValidationError(): ValidationError;
|
|
@@ -4245,16 +4240,10 @@ type ResourceTranslation = {
|
|
|
4245
4240
|
* - Language code for this translation
|
|
4246
4241
|
*/
|
|
4247
4242
|
locale?: string;
|
|
4248
|
-
value?: TranslationValue;
|
|
4249
|
-
};
|
|
4250
|
-
/** @returns {TranslationValue} */
|
|
4251
|
-
declare function TranslationValue(): TranslationValue;
|
|
4252
|
-
type TranslationValue = {
|
|
4253
4243
|
/**
|
|
4254
|
-
* - Translated
|
|
4244
|
+
* - Translated content in key-value format
|
|
4255
4245
|
*/
|
|
4256
|
-
|
|
4257
|
-
seo?: TranslationSeo;
|
|
4246
|
+
value?: any;
|
|
4258
4247
|
};
|
|
4259
4248
|
/** @returns {TranslationSeo} */
|
|
4260
4249
|
declare function TranslationSeo(): TranslationSeo;
|
|
@@ -4300,12 +4289,18 @@ type ResourceTranslationCreate = {
|
|
|
4300
4289
|
* - Target language code for the translation
|
|
4301
4290
|
*/
|
|
4302
4291
|
locale?: string;
|
|
4303
|
-
|
|
4292
|
+
/**
|
|
4293
|
+
* - Translated content in key-value format
|
|
4294
|
+
*/
|
|
4295
|
+
value?: any;
|
|
4304
4296
|
};
|
|
4305
4297
|
/** @returns {ResourceTranslationUpdate} */
|
|
4306
4298
|
declare function ResourceTranslationUpdate(): ResourceTranslationUpdate;
|
|
4307
4299
|
type ResourceTranslationUpdate = {
|
|
4308
|
-
|
|
4300
|
+
/**
|
|
4301
|
+
* - Translated content in key-value format
|
|
4302
|
+
*/
|
|
4303
|
+
value?: any;
|
|
4309
4304
|
};
|
|
4310
4305
|
/** @returns {TranslatableSection} */
|
|
4311
4306
|
declare function TranslatableSection(): TranslatableSection;
|
|
@@ -1621,13 +1621,7 @@ const Joi = require("joi");
|
|
|
1621
1621
|
* @typedef ResourceTranslation
|
|
1622
1622
|
* @property {string} [_id] - Unique identifier for the translation entry
|
|
1623
1623
|
* @property {string} [locale] - Language code for this translation
|
|
1624
|
-
* @property {
|
|
1625
|
-
*/
|
|
1626
|
-
|
|
1627
|
-
/**
|
|
1628
|
-
* @typedef TranslationValue
|
|
1629
|
-
* @property {string} [name] - Translated name
|
|
1630
|
-
* @property {TranslationSeo} [seo]
|
|
1624
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1631
1625
|
*/
|
|
1632
1626
|
|
|
1633
1627
|
/**
|
|
@@ -1649,12 +1643,12 @@ const Joi = require("joi");
|
|
|
1649
1643
|
* @property {string} [type] - Type of content being translated
|
|
1650
1644
|
* @property {string} [resource_id] - Identifier of the resource requiring translation
|
|
1651
1645
|
* @property {string} [locale] - Target language code for the translation
|
|
1652
|
-
* @property {
|
|
1646
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1653
1647
|
*/
|
|
1654
1648
|
|
|
1655
1649
|
/**
|
|
1656
1650
|
* @typedef ResourceTranslationUpdate
|
|
1657
|
-
* @property {
|
|
1651
|
+
* @property {Object} [value] - Translated content in key-value format
|
|
1658
1652
|
*/
|
|
1659
1653
|
|
|
1660
1654
|
/**
|
|
@@ -3690,15 +3684,7 @@ class ContentPlatformModel {
|
|
|
3690
3684
|
return Joi.object({
|
|
3691
3685
|
_id: Joi.string().allow(""),
|
|
3692
3686
|
locale: Joi.string().allow(""),
|
|
3693
|
-
value:
|
|
3694
|
-
});
|
|
3695
|
-
}
|
|
3696
|
-
|
|
3697
|
-
/** @returns {TranslationValue} */
|
|
3698
|
-
static TranslationValue() {
|
|
3699
|
-
return Joi.object({
|
|
3700
|
-
name: Joi.string().allow(""),
|
|
3701
|
-
seo: ContentPlatformModel.TranslationSeo(),
|
|
3687
|
+
value: Joi.object().pattern(/\S/, Joi.any()),
|
|
3702
3688
|
});
|
|
3703
3689
|
}
|
|
3704
3690
|
|
|
@@ -3728,14 +3714,14 @@ class ContentPlatformModel {
|
|
|
3728
3714
|
type: Joi.string().allow(""),
|
|
3729
3715
|
resource_id: Joi.string().allow(""),
|
|
3730
3716
|
locale: Joi.string().allow(""),
|
|
3731
|
-
value:
|
|
3717
|
+
value: Joi.object().pattern(/\S/, Joi.any()),
|
|
3732
3718
|
});
|
|
3733
3719
|
}
|
|
3734
3720
|
|
|
3735
3721
|
/** @returns {ResourceTranslationUpdate} */
|
|
3736
3722
|
static ResourceTranslationUpdate() {
|
|
3737
3723
|
return Joi.object({
|
|
3738
|
-
value:
|
|
3724
|
+
value: Joi.object().pattern(/\S/, Joi.any()),
|
|
3739
3725
|
});
|
|
3740
3726
|
}
|
|
3741
3727
|
|
|
@@ -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 {
|
|
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.
|
|
@@ -3514,7 +3551,7 @@ export = OrderPlatformModel;
|
|
|
3514
3551
|
* your order was placed. This field will be phased out after version 2.4.0.
|
|
3515
3552
|
* Please use ordering_source instead to ensure accurate order tracking and processing.
|
|
3516
3553
|
* @property {string} [ordering_source] - To uniquely identify the source
|
|
3517
|
-
* through which order has been placed.
|
|
3554
|
+
* through which order has been placed (e.g, marketplace, gofynd).
|
|
3518
3555
|
* @property {Object} [meta] - Meta data of the order contains additional,
|
|
3519
3556
|
* potentially dynamic information about the order.
|
|
3520
3557
|
*/
|
|
@@ -4285,7 +4322,7 @@ export = OrderPlatformModel;
|
|
|
4285
4322
|
* your order was placed. This field will be phased out after version 2.4.0.
|
|
4286
4323
|
* Please use ordering_source instead to ensure accurate order tracking and processing.
|
|
4287
4324
|
* @property {string} [ordering_source] - To uniquely identify the source
|
|
4288
|
-
* through which order has been placed.
|
|
4325
|
+
* through which order has been placed (e.g, marketplace, gofynd).
|
|
4289
4326
|
* @property {string} order_date - Specifies the exact date and time when the
|
|
4290
4327
|
* order was placed by the customer, serving as a key timestamp for the
|
|
4291
4328
|
* initiation of the order processing cycle.
|
|
@@ -4953,10 +4990,99 @@ export = OrderPlatformModel;
|
|
|
4953
4990
|
* @property {boolean} [status]
|
|
4954
4991
|
* @property {string} [error]
|
|
4955
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
|
+
*/
|
|
4956
5082
|
declare class OrderPlatformModel {
|
|
4957
5083
|
}
|
|
4958
5084
|
declare namespace OrderPlatformModel {
|
|
4959
|
-
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, 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 };
|
|
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 };
|
|
4960
5086
|
}
|
|
4961
5087
|
/** @returns {InvalidateShipmentCachePayload} */
|
|
4962
5088
|
declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
|
|
@@ -5530,6 +5656,67 @@ type OrderDataUpdates = {
|
|
|
5530
5656
|
*/
|
|
5531
5657
|
data?: any;
|
|
5532
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
|
+
};
|
|
5533
5720
|
/** @returns {DataUpdates} */
|
|
5534
5721
|
declare function DataUpdates(): DataUpdates;
|
|
5535
5722
|
type DataUpdates = {
|
|
@@ -5549,6 +5736,13 @@ type DataUpdates = {
|
|
|
5549
5736
|
*/
|
|
5550
5737
|
entities?: EntitiesDataUpdates[];
|
|
5551
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[];
|
|
5552
5746
|
};
|
|
5553
5747
|
/** @returns {TransitionComments} */
|
|
5554
5748
|
declare function TransitionComments(): TransitionComments;
|
|
@@ -6603,7 +6797,7 @@ type OrderDetails = {
|
|
|
6603
6797
|
ordering_channel?: string;
|
|
6604
6798
|
/**
|
|
6605
6799
|
* - To uniquely identify the source
|
|
6606
|
-
* through which order has been placed.
|
|
6800
|
+
* through which order has been placed (e.g, marketplace, gofynd).
|
|
6607
6801
|
*/
|
|
6608
6802
|
ordering_source?: string;
|
|
6609
6803
|
/**
|
|
@@ -9610,7 +9804,7 @@ type TransitionConfigCondition = {
|
|
|
9610
9804
|
ordering_channel?: string;
|
|
9611
9805
|
/**
|
|
9612
9806
|
* - To uniquely identify the source
|
|
9613
|
-
* through which order has been placed.
|
|
9807
|
+
* through which order has been placed (e.g, marketplace, gofynd).
|
|
9614
9808
|
*/
|
|
9615
9809
|
ordering_source?: string;
|
|
9616
9810
|
/**
|
|
@@ -10430,7 +10624,7 @@ type Address = {
|
|
|
10430
10624
|
* - A unique identifier for the
|
|
10431
10625
|
* delivery address.
|
|
10432
10626
|
*/
|
|
10433
|
-
delivery_address_id?:
|
|
10627
|
+
delivery_address_id?: number;
|
|
10434
10628
|
/**
|
|
10435
10629
|
* - An object containing additional
|
|
10436
10630
|
* geographical information related to the address.
|
|
@@ -11865,7 +12059,7 @@ type ShipmentItem = {
|
|
|
11865
12059
|
order_date?: string;
|
|
11866
12060
|
/**
|
|
11867
12061
|
* - The timestamp indicating when the
|
|
11868
|
-
* order was created.
|
|
12062
|
+
* order was created in UTC format.
|
|
11869
12063
|
*/
|
|
11870
12064
|
order_created_ts?: string;
|
|
11871
12065
|
shipment_status?: ShipmentStatus;
|
|
@@ -11877,7 +12071,7 @@ type ShipmentItem = {
|
|
|
11877
12071
|
estimated_sla_time?: string;
|
|
11878
12072
|
/**
|
|
11879
12073
|
* - The timestamp for the estimated SLA,
|
|
11880
|
-
* providing a specific time for expected delivery.
|
|
12074
|
+
* providing a specific time for expected delivery in UTC format.
|
|
11881
12075
|
*/
|
|
11882
12076
|
estimated_sla_ts?: string;
|
|
11883
12077
|
delivery_address?: Address;
|
|
@@ -11980,7 +12174,7 @@ type ShipmentItem = {
|
|
|
11980
12174
|
ordering_channnel?: string;
|
|
11981
12175
|
/**
|
|
11982
12176
|
* - To uniquely identify the source
|
|
11983
|
-
* through which order has been placed.
|
|
12177
|
+
* through which order has been placed (e.g, marketplace, gofynd).
|
|
11984
12178
|
*/
|
|
11985
12179
|
ordering_source?: string;
|
|
11986
12180
|
/**
|
|
@@ -12198,7 +12392,7 @@ type OrderDetailsData = {
|
|
|
12198
12392
|
ordering_channel?: string;
|
|
12199
12393
|
/**
|
|
12200
12394
|
* - To uniquely identify the source
|
|
12201
|
-
* through which order has been placed.
|
|
12395
|
+
* through which order has been placed (e.g, marketplace, gofynd).
|
|
12202
12396
|
*/
|
|
12203
12397
|
ordering_source?: string;
|
|
12204
12398
|
/**
|
|
@@ -13853,7 +14047,7 @@ type OrderData = {
|
|
|
13853
14047
|
ordering_channel?: string;
|
|
13854
14048
|
/**
|
|
13855
14049
|
* - To uniquely identify the source
|
|
13856
|
-
* through which order has been placed.
|
|
14050
|
+
* through which order has been placed (e.g, marketplace, gofynd).
|
|
13857
14051
|
*/
|
|
13858
14052
|
ordering_source?: string;
|
|
13859
14053
|
/**
|
|
@@ -14944,3 +15138,10 @@ type BulkFailedResponseSchema = {
|
|
|
14944
15138
|
status?: boolean;
|
|
14945
15139
|
error?: string;
|
|
14946
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";
|