Application
Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.
Events
application/shipment/create/v1
# this event is triggered when shipment is created
application/shipment/update/v1
# this event is triggered when shipment is updated
application/shipment/data_update/v1
# this event is triggered when shipment is data_updated
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Event object that is being produced
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Payload produced by the OMS
Properties
shipment
object
Required
Shipment related details
Properties
status
string
Required
Webhook shipment status, i.e., either create or update
shipment_status
object
Required
Status of the shipment indicating its current stage
Properties
created_at
string
Required
Shipment status created timestamp
created_ts
string
Required
Shipment status created timestamp
id
number
Required
Unique identifier associated with the shipment's status object
updated_ts
string
Required
Shipment status updated timestamp
bag_list
array of string
Required
List of Bag ids transitioned in this shipment's status
shipment_id
string
Required
Unique shipment no. that is auto-generated
status
string
Required
Shipment's operational status
current_shipment_status
string
Required
Current shipment's status; it can be financial, logistics or operational
status_created_at
string
Required
application_id
string
Required
ID of the sales channel to which the shipment belongs
shipment_id
string
Required
Unique shipment no. that is auto-generated
company_id
number
Required
ID of the company fulfilling the shipment
app_company_id
number|null|string
Required
ID of the company from which order was placed
order_id
string
Required
Unique ID of order in which the shipment is present
merchant_id
string
Required
Unique merchant id
user
object
Required
Purchaser's details such as name, last name, mobile no. and email
Properties
email
string|null
Email address of the purchaser user
id
number|null
Unique identifier for the purchaser user within the system
gender
null|string
Gender of the purchaser user (e.g., male, female, other)
first_name
string
First name of the purchaser user
external_customer_id
string|null
External identifier associated with the purchaser user in another system
mobile
string|null
Mobile phone number of the purchaser user
last_name
string
Last name of the purchaser user
mongo_user_id
string|null
User's object ID in mongodb collection
user_oid
string|null
User Object ID assigned within the system
country_phone_code
string|null
Country phone code associated with the purchaser user's mobile number
is_anonymous_user
boolean
Flag indicating whether the user is anonymous
delivery_address
object
Required
Address where the shipment is to be delivered
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the recipient's name or the organization name associated with the address
email
string
Email of the recipient associated with the delivery address
phone
string
Mobile phone number of recipient associated with the delivery address
state
string
A string indicating the state or province of the delivery address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
user_id
number|null
Unique identifier for the fulfilling user within the system
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the recipient associated with the delivery address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the delivery address was created
first_name
string
First name of the recipient associated with the delivery address
updated_at
string
| date-time
Date and time when the delivery address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the delivery address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the delivery address
display_address
string
Formatted display version of the delivery address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
billing_address
object
Required
Address by which the invoice is created
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the billing user's name or the organization name associated with the address
email
string
Email address associated with the billing address user
phone
string
Phone number associated with the billing address user
state
string
A string indicating the state or province of the billing address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the individual associated with the billing address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the billing address was created
first_name
string
First name of the individual associated with the billing address
updated_at
string
| date-time
Date and time when the billing address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the billing address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the billing address
display_address
string
Formatted display version of the billing address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
delivery_partner_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
bags
array of object
Required
Details of all the products/articles in a shipment
Array of Properties
financial_breakup
array of object
Required
Financial breakup of an item
Array of Properties
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
discount
number
Required
The total amount discounted from the original MRP/actual price
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
identifiers
object
Required
Product identifiers
Properties
sku_code
string
SKU code of the product
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
total_units
number
Required
Total number of units of the item
value_of_good
number
Required
Effective selling price - Product GST Amount
item_name
string
Required
The name of the item being referenced
size
string
Required
The physical dimensions or specifications of the item, indicating its size or measurements
loyalty_discount
number
Amount reduced from the payable price when the customer applies loyalty program points while placing the order
entity_type
string
Required
Type of entity - bag, shipment
item
object
Required
Item details
Properties
l3_category_name
string
The name of the level 3 category to which the item belongs
l1_category_id
number
ID representing the level 2 category classification of the item
code
string
A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes
branch_url
null|string
Branch URL
l2_category
array of string
l3_category
number
ID representing the level 3 category classification of the item
last_updated_at
string
| date-time
Timestamp when the item was last updated
id
number
ID of the item that is being referred
name
string
The name of the item being referenced
can_return
boolean
Flag indicating if the item is eligible for return
webstore_product_url
null|string
Product URL
gender
null|string
Gender associated with an item
l2_category_id
number
ID representing the level 2 category classification of the item
color
null|string
Color associated with and item
slug_key
string
Automatically generated unique slug of the item
can_cancel
boolean
Flag indicating if the item is eligible for cancellation
attributes
object
An object containing descriptive properties of the item
Properties
name
string
The name or title of the item
color
string
The color description of the item
essential
string
Indicates whether the item is considered essential
brand_name
string
The brand name of the item
primary_color
string
The primary color of the item
primary_color_hex
string
The hexadecimal code representing the primary color
primary-colour-hex-code
string
The hexadecimal code representing the primary color
media
array of object
An array containing media files associated with the item
brand_id
number
The unique identifier associated with the brand of the item
brand
string
The brand or manufacturer of the item
l1_category
array of string
department_id
number
The unique identifier representing the department or category to which the item belongs
size
string
The size or dimensions of the item
image
array of string
brand
object
Required
Brand's information
Properties
credit_note_allowed
boolean
Required
If a credit note ID needs to be generated by the system
created_on
string
Required
Date and time when the brand was registered or created
id
number
Required
Unique identifier assigned to the brand for reference and identification
logo
string
Required
Visual representation or emblem associated with the brand
modified_on
string
Required
Date and time of the most recent update or modification to the brand's information
is_virtual_invoice
boolean
Required
If invoice ID needs to be generated by the system
brand_name
string
Required
Name or title of the brand used for identification and representation
bag_id
number
Required
The unique identifier associated with the bag
article
object
Required
Details of the article
Properties
identifiers
object
Required
Product identifiers
Properties
sku_code
string
esp_modified
string|boolean
Required
Flag representing if effective selling price has been modified
size
string
Required
The physical dimensions or specifications of the article, indicating its size or measurements
code
string
Required
A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes
set
object
Required
Details of the set article containing size distribution
Properties
quantity
integer
Number of units present
size_distribution
object
Object indicating the distribution of size and quantity of a set article
Properties
sizes
array of object
Array indicating size wise units present in a set article
Array of Properties
pieces
integer
Number of units of a particular size
size
string
Size of the article
is_set
string|boolean
Required
A boolean indicating whether the article is a set
seller_identifier
string
Required
Seller's identifier of the article
return_config
object
Required
Return configuration details of the article
Properties
time
number
Required
Number indicating number of hours or days
unit
string
Required
String indicating the unit of the time, eg. days, hours
returnable
boolean
Required
Flag indicating whether product is returnable or not
_id
string
Required
DB generated ID of the article
uid
string
Required
UID of the article
child_details
object|array
Required
Child article details if any
bundle_details
object
Contains bundle-related metadata for the shipment.
Properties
bundle_group_id
string
Unique group identifier for the bundle.
name
string
Name of the bundle.
slug
string
URL-friendly identifier for the bundle.
price_marked
number
Maximum Retail Price of the bundle.
price_effective
number
Current selling price of the bundle.
item_id
integer
Unique identifier for the item.
item_type
string
Type of the item (physical_bundle, virtual_bundle).
Enum
return_config
object
Refund Config for bundle product
Properties
allow_partial_return
boolean
Nullable
The line number of the parent bag.
returnable
boolean
Nullable
The line number of the parent bag.
unit
boolean
Nullable
The line number of the parent bag.
time
boolean
Nullable
The line number of the parent bag.
seller_identifier
string
Identifier for the seller of the bundle.
images
array of string
An array of image URLs associated with the bundle.
bundle_article_quantity
integer
Article net_quantity in bundle Product.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
dimensions
object
Required
The dimension object of the article/item
Properties
height
number|null
The height of the product
width
number|null
The width of the product
is_default
boolean|null
Whether the dimension is the default one or not
unit
string|null
The unit of dimension
length
number|null
The length of the product
weight
object
Required
Object containing weight details of item/article
Properties
unit
string
The unit of weight
shipping
number
The shipping weight of the product
is_default
boolean
Whether the weight is the default one or not
currency
object
Required
Order currency details
Properties
code
string
Currency code
rate
number
The conversion rate value
expiration_date
Undefined Type
Required
current_operational_status
object
Required
Properties
created_at
string
| date-time
Required
Date and time when the shipment status record was created
created_ts
string
Required
Timestamp indicating the exact time when the shipment status record was created
id
number
Required
Unique identifier for the shipment status record
kafka_sync
boolean
Required
Flag indicating whether the shipment status update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the shipment status record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the shipment status record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
ID of the fulfilling store of the shipment
status
string
Required
Current operational status of the shipment
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Details of the user who initiated the change in the shipment's status
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
affiliate_bag_details
object
Required
Object containing external bag details like external order id, external bag id
Properties
affiliate_bag_id
string
Required
External bag id
affiliate_order_id
string
Required
External order id
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
quantity
number
Required
Total quantity of the article present in the bag.
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
price_effective
number
Required
MRP - Initial Seller provided discount
discount
number
Required
The total amount discounted from the original MRP/actual price
amount_paid
number
Required
Amount paid by the customer
coupon_effective_discount
number
Required
Coupon provided by brand or seller
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cod_charges
number
Required
The fee associated with the COD order
refund_credit
number
Required
Refund credits provided to the customer
cashback
number
Required
Cashback points
refund_amount
number
Required
Amount to be refunded on cancellation and return
added_to_fynd_cash
boolean
Required
Flag indicating whether fynd cash has been used
cashback_applied
number
Required
Cashback applied on the order
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
value_of_good
number
Required
Effective selling price - Product GST Amount
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
transfer_price
number
Required
article
brand_calculated_amount
number
Required
Price Effective - Coupon Discount (Seller) - Promotion (Seller)
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
gift_price
number
Required
Gift card amount used
coupon_value
number
Required
Stores the coupon value as shown in the cart
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
amount_paid_roundoff
number
Required
Amount paid rounded off
loyalty_discount
number
Amount reduced from the payable price when the customer applies loyalty program points while placing the order
order_created
string
Required
Order creation timestamp
gst_details
object
Required
GST details associated with the bag
Properties
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
is_default_hsn_code
boolean
Required
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
hsn_code_id
string|null
Required
The unique identifier associated with HSN code
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
igst_tax_percentage
number
Required
Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions
sgst_tax_percentage
number
Required
Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state
cgst_tax_percentage
number
Required
Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state
igst_gst_fee
string|number
Required
Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions
cgst_gst_fee
string
Required
Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state
sgst_gst_fee
string
Required
Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state
tax_rule_id
string
ID of the tax rule associated with the product
line_number
number
Required
Unique identifier associated with each bag in a shipment
applied_promos
array of object
Required
Details of the applied promotions
Array of Properties
promo_id
string
Promotion id
buy_rules
array of object
Buy rules for promotions
Array of Properties
item_criteria
object
Item criteria of promotion
cart_conditions
object
Cart conditions details for promotion
offer_text
string
Offer text of current promotion
promotion_group
string
Promotion group for the promotion
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_name
string
Promotion name of current promotion
amount
number
Per unit discount amount applied with current promotion
discount_rules
array of object
Discount rules for promotions
Array of Properties
matched_buy_rules
array of string
Matched buy rules for promotion
raw_offer
object
raw offer details for promotion
offer
object
offer for promotion
item_criteria
object
Item criteria of promotion
ownership
object
Ownership of promotion
Properties
payable_category
string
promo amount payable category
payable_by
string
promo amount bearable party
article_quantity
integer
Quantity of article on which promotion is applicable
applied_free_articles
array of object
Applied free article for free gift item promotions
Array of Properties
free_gift_item_details
object
Free gift items details
Properties
item_slug
string
item slug
item_name
string
Item name
item_price_details
object
item price details
item_brand_name
string
item brand name
item_id
integer
Item id
item_images_url
array of string
item images URL
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
Free article quantity
article_id
string
free article id
promotion_type
string
Promotion type of current promotion
meta
object
Meta object for extra data
code
string|null
Promotion code
taxes
array of object
Required
Details of taxes applied on products
Array of Properties
name
string
Name of the tax applied (e.g., GST, CGST, SGST, VAT)
rate
number
Tax rate applied, represented as a decimal value (e.g., 0.09 for 9%)
taxable_amount
number
Amount on which the tax is calculated, after applicable discounts or exemptions
tax_amount
number
Final tax amount calculated using the tax rate on the taxable amount
bag_status_history
array of object
Required
Records the changes in status for a bag, providing a timeline of events and transitions
Array of Properties
created_at
string
| date-time
Required
Date and time when the bag status history record was created.
created_ts
string
Required
Timestamp indicating the exact time when the bag status history record was created
id
number
Required
Unique identifier for the bag status history record
kafka_sync
boolean
Required
Flag indicating whether the bag status history update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the bag status history record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the bag status history record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
Store id associated with the bag
status
string
Required
Webhook shipment status, i.e., either create or update
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
fulfilling_store
object
Required
Details of the store responsible for fulfilling the order
Properties
id
number
Required
Unique identifier for the store.
code
string
Required
Alphanumeric code representing the store.
name
string
Required
Name of the store.
address
string
Required
Physical address of the store.
state
string
Required
State where the store is located.
city
string
Required
City where the store is located.
pincode
string
Required
Postal code (pincode) of the store's location.
country
string
Required
Country where the store is situated.
phone
string
Required
Contact phone number for the store.
fulfillment_channel
string
Required
Type of fulfillment channel used by the store.
location_type
string
Required
Type of location e.g., warehouse, high_street
Enum
company_id
number
Required
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Required
Boolean indicating whether the store is currently active
tags
array of string
Required
Array of tags associated with the store
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
amount_paid
number
Required
Amount paid by the customer
refund_amount
number
Required
Amount to be refunded on cancellation and return
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
cod_charges
number
Required
The fee associated with the COD order
discount
number
Required
The total amount discounted from the original MRP/actual price
cashback_applied
number
Required
Cashback applied on the order
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cashback
number
Required
Cashback points
price_effective
number
Required
MRP - Initial Seller provided discount
refund_credit
number
Required
Refund credits provided to the customer
value_of_good
number
Required
Effective selling price - Product GST Amount
coupon_value
number
Required
Stores the coupon value as shown in the cart
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
cn_refund_amount
number
Required
Amount to be refunded through credit note
gift_price
number
Required
Gift card amount used
amount_paid_roundoff
number
Amount paid rounded off
loyalty_discount
number
Amount reduced from the payable price when the customer applies loyalty program points while placing the order
payments
object
Required
Object containing payment mode and payment breakup
Properties
id
number
Required
Unique identifier for the payment mode
mode
string
Required
Type or category of the payment mode (e.g., PP, COD)
logo
string
Required
URL or path to the logo/icon representing the payment mode
display_name
string
Required
Name or label used to display the payment mode
display_priority
number
Required
Priority order for displaying the payment mode
source
string
Required
Merchant of the payment mode (e.g., PartnerPay, JioPp)
is_active
boolean
Required
Boolean indicating whether the payment mode is currently active
affiliate_details
object
Required
Application related details like config, order_id, shipment id
Properties
id
string|number
Required
Identifier for the application, can be application_id or extension_id
affiliate_bag_id
string
Required
Identifier assigned by the application for the bag
affiliate_order_id
string
Required
Identifier of the order assigned by the application
company_affiliate_tag
string
Required
Tag associated with the bag from the application's company
affiliate_id
string
Required
Identifier for the application, can be application_id or extension_id
affiliate_shipment_id
string
Required
Identifier of the shipment assigned by the application
affiliate_store_id
string
Required
Identifier of the store assigned by the application
pdf_links
object
Required
PDF Links pushed by the application or extension
Properties
label_type
string
Required
Label type - external
invoice_type
string
Required
Invoice type - external
label
string
Label URL provided by the application or extension
invoice
string
Invoice URL provided by the application or extension
config
object
Required
Application configuration details
Properties
id
string|number
Identifier for the application, can be application_id or extension_id
name
string
Application name
token
null|string
Application token - deprecated
dp_assignment
boolean
Flag indicating whether auto DP assignment should happen from system
app_company_id
number|null|string
ID of the company from which order was placed
article_assignment
object
The article assignment settings
Properties
strategy
string
Enum
level
string
Enum
force_reassignment
boolean
Indicates whether force reassignment is enabled
sales_channel_logo
string
Logo URL of the application to which order belongs
ordering_channel_logo
string
Logo URL of the ordering channel
post_order_reassignment
boolean
Indicates whether post-order reassignment is enabled
dp_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
rto_address
object
Required
The address to which shipment should be delivered in case of RTO
Properties
company_id
number
Required
ID of the company fulfilling the shipment
id
number
Required
ID of the store where RTO should happen
name
string
Required
A string representing the store's name
store_address_json
object
Required
Store address details
Properties
version
string
Address version, to be deprecated
contact_person
string
Name of the contact person associated with the address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
name
string
A string representing the store's name
area
string
A string specifying the locality or area associated with the address
area_code
string
Area code of the address
area_code_slug
string
Unique identifier or slug for the area code associated with the address
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
city
string
A string denoting the city or municipality of the address
state
string
A string indicating the state or province of the address
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
longitude
number|string
The longitude of the address
sector
string
A string specifying the sector or district of the address if applicable
latitude
number|string
The latitude of the address
phone
string
Mobile phone number of recipient associated with the address
email
string
Email of the recipient associated with the address
address_type
string
Type of address (e.g., home, office, registered)
address_category
string
Category or classification of the address
created_at
string
| date-time
Date and time when the address was created
updated_at
string
| date-time
Date and time when the address was last updated
country_phone_code
string|null
Phone code for the country of the address
country_iso_code
string
ISO code representing the country of the address
country_code
string
ISO code representing the country of the address
display_address
string
Formatted display version of the address
code
string
Required
Alphanumeric code representing the store
location_type
string
Required
Type of location e.g., warehouse, high_street
address1
string
Required
"A string representing the first line of the address, typically containing street or building information"
address2
string
Required
"A string representing the second line of the address, which can be used for additional address details if needed"
display_address
string
Required
Formatted display version of the address
city
string
Required
A string denoting the city or municipality of the address
state
string
Required
A string indicating the state or province of the address
sector
string
Required
A string specifying the sector or district of the address if applicable
country
string
Required
A string indicating the country of the address
pincode
string
Required
A string indicating the postal code or PIN code of the address area
store_email
string
Required
Email of the recipient associated with the store
contact_person
string
Required
Name of the contact person associated with the address
phone
string
Required
Mobile phone number of recipient associated with the address
weight
object
Required
Shipment weight
Properties
value
number
Required
unit
string
Required
shipment_gst
object
Required
GST details associated with the shipment
Properties
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
store_invoice_id
string|null
Required
Invoice ID attached to the shipment
credit_note_id
string|null
Required
Credit Note ID attached to the shipment
order_created
string
Required
Order creation timestamp
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
payment_info
array of Undefined Type
Required
"Array of object containing payment methods used for placing an order."
order
object
Required
Order level details
Properties
ordering_channel
string
Required
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Nullable
To uniquely identify the source through which order has been placed.
affiliate_order_date
string|null
| date-time
Required
Order creation timestamp at application/extension end
affiliate_order_id
string
Required
Identifier of the order assigned by the application
fynd_order_id
string
Required
System generated unique identifier of the order
mode_of_payment
string
Required
Unique identifier associated with the payment mode
source
string
Required
Ordering source eg. affiliate, fynd
total_order_value
number
Required
Total order value
collect_by
string
Required
Whomsoever collected the money
refund_by
string
Required
Whomsoever will refund the money
order_value
number
Required
Value of the order
loyalty_discount_details
object
Applied loyalty discount information
Properties
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order
order_source
string
Required
Ordering source eg. affiliate, fynd
journey_type
string|null
Required
Journey type forward or return
einvoice_info
object
Required
Einvoice info if e-invoice is applicable
Properties
credit_note
object
Details of the reverse credit note einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
invoice
object
Details of the forward invoice einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
lock_status
boolean
Required
Lock status of the shipment
original_bag_list
array of number
Required
List of Bag ids when the order was created
shipment_update_time
number
Required
Last shipment update time
previous_shipment_id
string|null
Required
"ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition"
fyndstore_emp
object
Required
Fynd store employee details
ordering_store
object
Required
Store details from which order was placed in case of StoreOS
Properties
id
number
Unique identifier for the store.
code
string
Alphanumeric code representing the store.
name
string
Name of the store.
address
string
Physical address of the store.
state
string
State where the store is located.
city
string
City where the store is located.
pincode
string
Postal code (pincode) of the store's location.
country
string
Country where the store is situated.
phone
string
Contact phone number for the store.
fulfillment_channel
string
Type of fulfillment channel used by the store.
location_type
string
Type of location e.g., warehouse, high_street
Enum
company_id
number
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Boolean indicating whether the store is currently active
tags
array of string
Array of tags associated with the store
coupon
object
Required
Coupon related details
cart_info
object
Required
Cart related information
Properties
cart_id
string
Required
The unique identifier of the cart
cart_uid
number
Required
UID associated with the cart
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "description": "Event object that is being produced",32 "required": [33 "category",34 "created_timestamp",35 "id",36 "name",37 "trace_id",38 "type",39 "version"40 ],41 "properties": {42 "category": {43 "type": "string",44 "description": "category of the event. If it is at sales channel level or company level"45 },46 "created_timestamp": {47 "type": "integer",48 "description": "event generation timestamp in epoch milliseconds"49 },50 "id": {51 "type": "string",52 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"53 },54 "name": {55 "type": "string",56 "description": "Name of the event"57 },58 "trace_id": {59 "type": "array",60 "description": "internal trace_id for Fynd Platform services",61 "items": {62 "type": "string"63 }64 },65 "type": {66 "type": "string",67 "description": "Type/Action of the event. e.g. create/update/delete"68 },69 "version": {70 "type": "string",71 "description": "Version of the event."72 }73 }74 },75 "payload": {76 "type": "object",77 "description": "Payload produced by the OMS",78 "properties": {79 "shipment": {80 "type": "object",81 "description": "Shipment related details",82 "properties": {83 "status": {84 "type": "string",85 "description": "Webhook shipment status, i.e., either create or update"86 },87 "shipment_status": {88 "type": "object",89 "description": "Status of the shipment indicating its current stage",90 "properties": {91 "created_at": {92 "type": "string",93 "description": "Shipment status created timestamp"94 },95 "created_ts": {96 "type": "string",97 "description": "Shipment status created timestamp"98 },99 "id": {100 "type": "number",101 "description": "Unique identifier associated with the shipment's status object"102 },103 "updated_ts": {104 "type": "string",105 "description": "Shipment status updated timestamp"106 },107 "bag_list": {108 "type": "array",109 "description": "List of Bag ids transitioned in this shipment's status",110 "items": {111 "type": "string"112 }113 },114 "shipment_id": {115 "type": "string",116 "description": "Unique shipment no. that is auto-generated"117 },118 "status": {119 "type": "string",120 "description": "Shipment's operational status"121 },122 "current_shipment_status": {123 "type": "string",124 "description": "Current shipment's status; it can be financial, logistics or operational"125 },126 "status_created_at": {127 "type": "string"128 }129 },130 "required": [131 "created_at",132 "created_ts",133 "id",134 "updated_ts",135 "bag_list",136 "shipment_id",137 "status",138 "current_shipment_status",139 "status_created_at"140 ]141 },142 "application_id": {143 "type": "string",144 "description": "ID of the sales channel to which the shipment belongs"145 },146 "shipment_id": {147 "type": "string",148 "description": "Unique shipment no. that is auto-generated"149 },150 "company_id": {151 "type": "number",152 "description": "ID of the company fulfilling the shipment"153 },154 "app_company_id": {155 "type": [156 "number",157 "null",158 "string"159 ],160 "description": "ID of the company from which order was placed"161 },162 "order_id": {163 "type": "string",164 "description": "Unique ID of order in which the shipment is present"165 },166 "merchant_id": {167 "type": "string",168 "description": "Unique merchant id"169 },170 "user": {171 "type": "object",172 "description": "Purchaser's details such as name, last name, mobile no. and email",173 "properties": {174 "email": {175 "type": [176 "string",177 "null"178 ],179 "description": "Email address of the purchaser user"180 },181 "id": {182 "type": [183 "number",184 "null"185 ],186 "description": "Unique identifier for the purchaser user within the system"187 },188 "gender": {189 "type": [190 "null",191 "string"192 ],193 "description": "Gender of the purchaser user (e.g., male, female, other)"194 },195 "first_name": {196 "type": "string",197 "description": "First name of the purchaser user"198 },199 "external_customer_id": {200 "type": [201 "string",202 "null"203 ],204 "description": "External identifier associated with the purchaser user in another system"205 },206 "mobile": {207 "type": [208 "string",209 "null"210 ],211 "description": "Mobile phone number of the purchaser user"212 },213 "last_name": {214 "type": "string",215 "description": "Last name of the purchaser user"216 },217 "mongo_user_id": {218 "type": [219 "string",220 "null"221 ],222 "description": "User's object ID in mongodb collection"223 },224 "user_oid": {225 "type": [226 "string",227 "null"228 ],229 "description": "User Object ID assigned within the system"230 },231 "country_phone_code": {232 "type": [233 "string",234 "null"235 ],236 "description": "Country phone code associated with the purchaser user's mobile number"237 },238 "is_anonymous_user": {239 "type": "boolean",240 "description": "Flag indicating whether the user is anonymous"241 }242 }243 },244 "delivery_address": {245 "type": "object",246 "description": "Address where the shipment is to be delivered",247 "properties": {248 "area": {249 "type": "string",250 "description": "A string specifying the locality or area associated with the address"251 },252 "city": {253 "type": "string",254 "description": "A string denoting the city or municipality of the address"255 },256 "name": {257 "type": "string",258 "description": "A string representing the recipient's name or the organization name associated with the address"259 },260 "email": {261 "type": "string",262 "description": "Email of the recipient associated with the delivery address"263 },264 "phone": {265 "type": "string",266 "description": "Mobile phone number of recipient associated with the delivery address"267 },268 "state": {269 "type": "string",270 "description": "A string indicating the state or province of the delivery address"271 },272 "address": {273 "type": "string",274 "description": "\"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""275 },276 "country": {277 "type": "string",278 "description": "A string indicating the country of the address"279 },280 "pincode": {281 "type": "string",282 "description": "A string indicating the postal code or PIN code of the address area"283 },284 "user_id": {285 "type": [286 "number",287 "null"288 ],289 "description": "Unique identifier for the fulfilling user within the system"290 },291 "version": {292 "type": "string",293 "description": "Address version, to be deprecated"294 },295 "address1": {296 "type": "string",297 "description": "\"A string representing the first line of the address, typically containing street or building information\""298 },299 "address2": {300 "type": "string",301 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""302 },303 "landmark": {304 "type": "string",305 "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""306 },307 "latitude": {308 "type": [309 "number",310 "string"311 ],312 "description": "The latitude of the address"313 },314 "area_code": {315 "type": "string",316 "x-not-enum": true,317 "description": "Area code of the address"318 },319 "last_name": {320 "type": "string",321 "description": "Last name of the recipient associated with the delivery address"322 },323 "longitude": {324 "type": [325 "number",326 "string"327 ],328 "description": "The longitude of the address"329 },330 "created_at": {331 "type": "string",332 "format": "date-time",333 "description": "Date and time when the delivery address was created"334 },335 "first_name": {336 "type": "string",337 "description": "First name of the recipient associated with the delivery address"338 },339 "updated_at": {340 "type": "string",341 "format": "date-time",342 "description": "Date and time when the delivery address was last updated"343 },344 "address_type": {345 "type": "string",346 "x-not-enum": true,347 "description": "Type of address (e.g., home, office, registered)"348 },349 "geo_location": {350 "required": [],351 "description": "Geographic coordinates (latitude and longitude) of the delivery address",352 "type": "object",353 "properties": {354 "latitude": {355 "type": [356 "number",357 "string"358 ],359 "description": "The latitude of the geolocation"360 },361 "longitude": {362 "type": [363 "number",364 "string"365 ],366 "description": "The longitude of the geolocation"367 }368 }369 },370 "area_code_slug": {371 "type": "string",372 "description": "Unique identifier or slug for the area code associated with the address"373 },374 "contact_person": {375 "type": "string",376 "description": "Name of the contact person associated with the delivery address"377 },378 "display_address": {379 "type": "string",380 "description": "Formatted display version of the delivery address"381 },382 "address_category": {383 "type": "string",384 "x-not-enum": true,385 "description": "Category or classification of the delivery address"386 },387 "country_iso_code": {388 "type": "string",389 "x-not-enum": true,390 "description": "ISO code representing the country of the delivery address"391 },392 "country_phone_code": {393 "type": [394 "string",395 "null"396 ],397 "x-not-enum": true,398 "description": "Phone code for the country of the delivery address"399 }400 }401 },402 "billing_address": {403 "type": "object",404 "description": "Address by which the invoice is created",405 "properties": {406 "area": {407 "type": "string",408 "description": "A string specifying the locality or area associated with the address"409 },410 "city": {411 "type": "string",412 "description": "A string denoting the city or municipality of the address"413 },414 "name": {415 "type": "string",416 "description": "A string representing the billing user's name or the organization name associated with the address"417 },418 "email": {419 "type": "string",420 "description": "Email address associated with the billing address user"421 },422 "phone": {423 "type": "string",424 "description": "Phone number associated with the billing address user"425 },426 "state": {427 "type": "string",428 "description": "A string indicating the state or province of the billing address"429 },430 "address": {431 "type": "string",432 "description": "\"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""433 },434 "country": {435 "type": "string",436 "description": "A string indicating the country of the address"437 },438 "pincode": {439 "type": "string",440 "description": "A string indicating the postal code or PIN code of the address area"441 },442 "version": {443 "type": "string",444 "description": "Address version, to be deprecated"445 },446 "address1": {447 "type": "string",448 "description": "\"A string representing the first line of the address, typically containing street or building information\""449 },450 "address2": {451 "type": "string",452 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""453 },454 "landmark": {455 "type": "string",456 "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""457 },458 "latitude": {459 "type": [460 "number",461 "string"462 ],463 "description": "The latitude of the address"464 },465 "area_code": {466 "type": "string",467 "x-not-enum": true,468 "description": "Area code of the address"469 },470 "last_name": {471 "type": "string",472 "description": "Last name of the individual associated with the billing address"473 },474 "longitude": {475 "type": [476 "number",477 "string"478 ],479 "description": "The longitude of the address"480 },481 "created_at": {482 "type": "string",483 "format": "date-time",484 "description": "Date and time when the billing address was created"485 },486 "first_name": {487 "type": "string",488 "description": "First name of the individual associated with the billing address"489 },490 "updated_at": {491 "type": "string",492 "format": "date-time",493 "description": "Date and time when the billing address was last updated"494 },495 "address_type": {496 "type": "string",497 "x-not-enum": true,498 "description": "Type of address (e.g., home, office, registered)"499 },500 "geo_location": {501 "required": [],502 "description": "Geographic coordinates (latitude and longitude) of the billing address",503 "type": "object",504 "properties": {505 "latitude": {506 "type": [507 "number",508 "string"509 ],510 "description": "The latitude of the geolocation"511 },512 "longitude": {513 "type": [514 "number",515 "string"516 ],517 "description": "The longitude of the geolocation"518 }519 }520 },521 "area_code_slug": {522 "type": "string",523 "description": "Unique identifier or slug for the area code associated with the address"524 },525 "contact_person": {526 "type": "string",527 "description": "Name of the contact person associated with the billing address"528 },529 "display_address": {530 "type": "string",531 "description": "Formatted display version of the billing address"532 },533 "address_category": {534 "type": "string",535 "x-not-enum": true,536 "description": "Category or classification of the delivery address"537 },538 "country_iso_code": {539 "type": "string",540 "x-not-enum": true,541 "description": "ISO code representing the country of the delivery address"542 },543 "country_phone_code": {544 "type": [545 "string",546 "null"547 ],548 "x-not-enum": true,549 "description": "Phone code for the country of the delivery address"550 }551 }552 },553 "delivery_partner_details": {554 "type": "object",555 "description": "Delivery Partner details",556 "properties": {557 "id": {558 "type": [559 "string",560 "number",561 "null"562 ],563 "description": "Unique identifier for the delivery partner"564 },565 "name": {566 "type": [567 "string",568 "null"569 ],570 "description": "Name of the delivery partner"571 },572 "awb_no": {573 "type": [574 "string",575 "null"576 ],577 "description": "Airway Bill (AWB) number associated with the delivery"578 },579 "eway_bill_id": {580 "type": [581 "string",582 "null"583 ],584 "description": "Electronic Way Bill (E-way Bill) ID for the delivery"585 },586 "track_url": {587 "type": [588 "string",589 "null"590 ],591 "description": "URL to track the delivery status or shipment details"592 },593 "gst_tag": {594 "type": [595 "string",596 "null"597 ],598 "description": "GST tag of the shipment"599 },600 "extension_id": {601 "type": [602 "string",603 "null"604 ],605 "description": "Unique Identifier of Courier partner Extension"606 },607 "scheme_id": {608 "type": [609 "string",610 "null"611 ],612 "description": "Unique identifier of a Courier partner scheme"613 },614 "courier_partner_slug": {615 "type": [616 "string",617 "null"618 ],619 "description": "Unique identifier containing extension_id and scheme_id"620 }621 },622 "required": [623 "id",624 "name",625 "awb_no",626 "eway_bill_id",627 "track_url",628 "gst_tag",629 "extension_id",630 "scheme_id",631 "courier_partner_slug"632 ]633 },634 "bags": {635 "type": "array",636 "description": "Details of all the products/articles in a shipment",637 "items": {638 "type": "object",639 "properties": {640 "financial_breakup": {641 "type": "array",642 "description": "Financial breakup of an item",643 "items": {644 "type": "object",645 "properties": {646 "brand_calculated_amount": {647 "type": "number",648 "description": "Effective selling price - Brand's additional discounts"649 },650 "discount": {651 "type": "number",652 "description": "The total amount discounted from the original MRP/actual price"653 },654 "gst_fee": {655 "type": "number",656 "description": "The fee associated with Goods and Services Tax (GST) for a product or service"657 },658 "gst_tax_percentage": {659 "type": "number",660 "description": "The percentage rate of GST applied to a product or service"661 },662 "gst_tag": {663 "type": [664 "string",665 "null"666 ],667 "description": "Type of GST applied - IGST, CGST, SGST"668 },669 "hsn_code": {670 "type": [671 "string",672 "null"673 ],674 "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"675 },676 "identifiers": {677 "type": "object",678 "description": "Product identifiers",679 "properties": {680 "sku_code": {681 "type": "string",682 "description": "SKU code of the product"683 }684 }685 },686 "price_marked": {687 "type": "number",688 "description": "The indicated price or value assigned to an item before any discounts or adjustments"689 },690 "tax_collected_at_source": {691 "type": "number",692 "description": "The tax amount collected at the source of income or transaction"693 },694 "tcs_percentage": {695 "type": "number",696 "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"697 },698 "total_units": {699 "type": "number",700 "description": "Total number of units of the item"701 },702 "value_of_good": {703 "type": "number",704 "description": "Effective selling price - Product GST Amount"705 },706 "item_name": {707 "type": "string",708 "description": "The name of the item being referenced"709 },710 "size": {711 "type": "string",712 "description": "The physical dimensions or specifications of the item, indicating its size or measurements"713 },714 "loyalty_discount": {715 "type": "number",716 "description": "Amount reduced from the payable price when the customer applies loyalty program points while placing the order"717 }718 },719 "required": [720 "brand_calculated_amount",721 "discount",722 "gst_fee",723 "gst_tax_percentage",724 "gst_tag",725 "hsn_code",726 "identifiers",727 "price_marked",728 "tax_collected_at_source",729 "tcs_percentage",730 "total_units",731 "value_of_good",732 "item_name",733 "size"734 ]735 }736 },737 "entity_type": {738 "type": "string",739 "description": "Type of entity - bag, shipment"740 },741 "item": {742 "type": "object",743 "description": "Item details",744 "properties": {745 "l3_category_name": {746 "type": "string",747 "description": "The name of the level 3 category to which the item belongs"748 },749 "l1_category_id": {750 "type": "number",751 "description": "ID representing the level 2 category classification of the item"752 },753 "code": {754 "type": "string",755 "description": "A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes"756 },757 "branch_url": {758 "type": [759 "null",760 "string"761 ],762 "description": "Branch URL"763 },764 "l2_category": {765 "type": "array",766 "items": {767 "type": "string",768 "x-not-enum": true,769 "description": "The name of the level 2 category to which the item belongs"770 }771 },772 "l3_category": {773 "type": "number",774 "x-not-enum": true,775 "description": "ID representing the level 3 category classification of the item"776 },777 "last_updated_at": {778 "type": "string",779 "format": "date-time",780 "description": "Timestamp when the item was last updated"781 },782 "id": {783 "type": "number",784 "description": "ID of the item that is being referred"785 },786 "name": {787 "type": "string",788 "description": "The name of the item being referenced"789 },790 "can_return": {791 "type": "boolean",792 "description": "Flag indicating if the item is eligible for return"793 },794 "webstore_product_url": {795 "type": [796 "null",797 "string"798 ],799 "description": "Product URL"800 },801 "gender": {802 "type": [803 "null",804 "string"805 ],806 "description": "Gender associated with an item"807 },808 "l2_category_id": {809 "type": "number",810 "description": "ID representing the level 2 category classification of the item"811 },812 "color": {813 "type": [814 "null",815 "string"816 ],817 "description": "Color associated with and item"818 },819 "slug_key": {820 "type": "string",821 "description": "Automatically generated unique slug of the item"822 },823 "can_cancel": {824 "type": "boolean",825 "description": "Flag indicating if the item is eligible for cancellation"826 },827 "attributes": {828 "type": "object",829 "description": "An object containing descriptive properties of the item",830 "properties": {831 "name": {832 "type": "string",833 "description": "The name or title of the item"834 },835 "color": {836 "type": "string",837 "description": "The color description of the item"838 },839 "essential": {840 "type": "string",841 "description": "Indicates whether the item is considered essential"842 },843 "brand_name": {844 "type": "string",845 "description": "The brand name of the item"846 },847 "primary_color": {848 "type": "string",849 "description": "The primary color of the item"850 },851 "primary_color_hex": {852 "type": "string",853 "description": "The hexadecimal code representing the primary color"854 },855 "primary-colour-hex-code": {856 "type": "string",857 "description": "The hexadecimal code representing the primary color"858 },859 "media": {860 "type": "array",861 "description": "An array containing media files associated with the item",862 "items": {863 "type": "object"864 }865 }866 }867 },868 "brand_id": {869 "type": "number",870 "description": "The unique identifier associated with the brand of the item"871 },872 "brand": {873 "type": "string",874 "description": "The brand or manufacturer of the item"875 },876 "l1_category": {877 "type": "array",878 "items": {879 "type": "string",880 "x-not-enum": true,881 "description": "The name of the level 1 category to which the item belongs"882 }883 },884 "department_id": {885 "type": "number",886 "description": "The unique identifier representing the department or category to which the item belongs"887 },888 "size": {889 "type": "string",890 "description": "The size or dimensions of the item"891 },892 "image": {893 "type": "array",894 "items": {895 "type": "string",896 "description": "Url of the item's image"897 }898 }899 }900 },901 "brand": {902 "type": "object",903 "description": "Brand's information",904 "properties": {905 "credit_note_allowed": {906 "type": "boolean",907 "description": "If a credit note ID needs to be generated by the system"908 },909 "created_on": {910 "type": "string",911 "description": "Date and time when the brand was registered or created"912 },913 "id": {914 "type": "number",915 "description": "Unique identifier assigned to the brand for reference and identification"916 },917 "logo": {918 "type": "string",919 "description": "Visual representation or emblem associated with the brand"920 },921 "modified_on": {922 "type": "string",923 "description": "Date and time of the most recent update or modification to the brand's information"924 },925 "is_virtual_invoice": {926 "type": "boolean",927 "description": "If invoice ID needs to be generated by the system"928 },929 "brand_name": {930 "type": "string",931 "description": "Name or title of the brand used for identification and representation"932 }933 },934 "required": [935 "credit_note_allowed",936 "created_on",937 "id",938 "logo",939 "modified_on",940 "is_virtual_invoice",941 "brand_name"942 ]943 },944 "bag_id": {945 "type": "number",946 "description": "The unique identifier associated with the bag"947 },948 "article": {949 "type": "object",950 "description": "Details of the article",951 "properties": {952 "identifiers": {953 "type": "object",954 "description": "Product identifiers",955 "properties": {956 "sku_code": {957 "type": "string"958 }959 }960 },961 "esp_modified": {962 "type": [963 "string",964 "boolean"965 ],966 "description": "Flag representing if effective selling price has been modified"967 },968 "size": {969 "type": "string",970 "description": "The physical dimensions or specifications of the article, indicating its size or measurements"971 },972 "code": {973 "type": "string",974 "description": "A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes"975 },976 "set": {977 "description": "Details of the set article containing size distribution",978 "type": "object",979 "properties": {980 "quantity": {981 "type": "integer",982 "description": "Number of units present"983 },984 "size_distribution": {985 "type": "object",986 "description": "Object indicating the distribution of size and quantity of a set article",987 "properties": {988 "sizes": {989 "type": "array",990 "description": "Array indicating size wise units present in a set article",991 "items": {992 "type": "object",993 "description": "Object indicating the size and quantity distribution of a set article",994 "properties": {995 "pieces": {996 "type": "integer",997 "description": "Number of units of a particular size"998 },999 "size": {1000 "type": "string",1001 "description": "Size of the article"1002 }1003 }1004 }1005 }1006 }1007 }1008 }1009 },1010 "is_set": {1011 "type": [1012 "string",1013 "boolean"1014 ],1015 "description": "A boolean indicating whether the article is a set"1016 },1017 "seller_identifier": {1018 "type": "string",1019 "description": "Seller's identifier of the article"1020 },1021 "return_config": {1022 "type": "object",1023 "description": "Return configuration details of the article",1024 "properties": {1025 "time": {1026 "type": "number",1027 "description": "Number indicating number of hours or days"1028 },1029 "unit": {1030 "type": "string",1031 "description": "String indicating the unit of the time, eg. days, hours"1032 },1033 "returnable": {1034 "type": "boolean",1035 "description": "Flag indicating whether product is returnable or not"1036 }1037 },1038 "required": [1039 "time",1040 "unit",1041 "returnable"1042 ]1043 },1044 "_id": {1045 "type": "string",1046 "description": "DB generated ID of the article"1047 },1048 "uid": {1049 "type": "string",1050 "description": "UID of the article"1051 },1052 "child_details": {1053 "type": [1054 "object",1055 "array"1056 ],1057 "description": "Child article details if any",1058 "properties": {},1059 "required": []1060 },1061 "bundle_details": {1062 "type": "object",1063 "description": "Contains bundle-related metadata for the shipment.",1064 "properties": {1065 "bundle_group_id": {1066 "type": "string",1067 "description": "Unique group identifier for the bundle."1068 },1069 "name": {1070 "type": "string",1071 "description": "Name of the bundle."1072 },1073 "slug": {1074 "type": "string",1075 "description": "URL-friendly identifier for the bundle."1076 },1077 "price_marked": {1078 "type": "number",1079 "description": "Maximum Retail Price of the bundle."1080 },1081 "price_effective": {1082 "type": "number",1083 "description": "Current selling price of the bundle."1084 },1085 "item_id": {1086 "type": "integer",1087 "description": "Unique identifier for the item."1088 },1089 "item_type": {1090 "type": "string",1091 "description": "Type of the item (physical_bundle, virtual_bundle).",1092 "enum": [1093 "virtual_bundle",1094 "physical_bundle"1095 ]1096 },1097 "return_config": {1098 "description": "Refund Config for bundle product",1099 "type": "object",1100 "properties": {1101 "allow_partial_return": {1102 "type": "boolean",1103 "nullable": true,1104 "description": "The line number of the parent bag."1105 },1106 "returnable": {1107 "type": "boolean",1108 "nullable": true,1109 "description": "The line number of the parent bag."1110 },1111 "unit": {1112 "type": "boolean",1113 "nullable": true,1114 "description": "The line number of the parent bag."1115 },1116 "time": {1117 "type": "boolean",1118 "nullable": true,1119 "description": "The line number of the parent bag."1120 }1121 }1122 },1123 "seller_identifier": {1124 "type": "string",1125 "description": "Identifier for the seller of the bundle."1126 },1127 "images": {1128 "type": "array",1129 "items": {1130 "type": "string"1131 },1132 "description": "An array of image URLs associated with the bundle."1133 },1134 "bundle_article_quantity": {1135 "type": "integer",1136 "description": "Article net_quantity in bundle Product."1137 },1138 "brand_name": {1139 "type": "string",1140 "description": "Identifier for the brand name."1141 },1142 "size": {1143 "type": "string",1144 "description": "Size associated with the bundle item."1145 }1146 }1147 },1148 "dimensions": {1149 "description": "The dimension object of the article/item",1150 "required": [],1151 "type": "object",1152 "properties": {1153 "height": {1154 "type": [1155 "number",1156 "null"1157 ],1158 "description": "The height of the product"1159 },1160 "width": {1161 "type": [1162 "number",1163 "null"1164 ],1165 "description": "The width of the product"1166 },1167 "is_default": {1168 "type": [1169 "boolean",1170 "null"1171 ],1172 "description": "Whether the dimension is the default one or not"1173 },1174 "unit": {1175 "type": [1176 "string",1177 "null"1178 ],1179 "description": "The unit of dimension"1180 },1181 "length": {1182 "type": [1183 "number",1184 "null"1185 ],1186 "description": "The length of the product"1187 }1188 }1189 },1190 "weight": {1191 "required": [],1192 "type": "object",1193 "description": "Object containing weight details of item/article",1194 "properties": {1195 "unit": {1196 "type": "string",1197 "description": "The unit of weight",1198 "example": "kg"1199 },1200 "shipping": {1201 "type": "number",1202 "description": "The shipping weight of the product",1203 "example": 1.51204 },1205 "is_default": {1206 "type": "boolean",1207 "description": "Whether the weight is the default one or not",1208 "example": true1209 }1210 }1211 },1212 "currency": {1213 "type": "object",1214 "description": "Order currency details",1215 "properties": {1216 "code": {1217 "type": "string",1218 "description": "Currency code"1219 },1220 "rate": {1221 "type": "number",1222 "description": "The conversion rate value"1223 }1224 },1225 "required": []1226 },1227 "expiration_date": {}1228 },1229 "required": [1230 "identifiers",1231 "esp_modified",1232 "size",1233 "code",1234 "set",1235 "is_set",1236 "seller_identifier",1237 "return_config",1238 "_id",1239 "uid",1240 "child_details",1241 "dimensions",1242 "weight",1243 "currency",1244 "expiration_date"1245 ]1246 },1247 "current_operational_status": {1248 "type": "object",1249 "properties": {1250 "created_at": {1251 "type": "string",1252 "format": "date-time",1253 "description": "Date and time when the shipment status record was created"1254 },1255 "created_ts": {1256 "type": "string",1257 "description": "Timestamp indicating the exact time when the shipment status record was created"1258 },1259 "id": {1260 "type": "number",1261 "description": "Unique identifier for the shipment status record"1262 },1263 "kafka_sync": {1264 "type": "boolean",1265 "description": "Flag indicating whether the shipment status update has been sync with Kafka"1266 },1267 "updated_ts": {1268 "type": "string",1269 "description": "Timestamp indicating the last time the shipment status record was updated"1270 },1271 "updated_at": {1272 "type": "string",1273 "format": "date-time",1274 "description": "Date and time of the most recent update to the shipment status record"1275 },1276 "delivery_partner_id": {1277 "type": [1278 "integer",1279 "null"1280 ],1281 "description": "Unique identifier of delivery partner"1282 },1283 "shipment_id": {1284 "type": "string",1285 "description": "Unique shipment no. that is auto-generated"1286 },1287 "store_id": {1288 "type": "number",1289 "description": "ID of the fulfilling store of the shipment"1290 },1291 "status": {1292 "type": "string",1293 "description": "Current operational status of the shipment"1294 },1295 "bag_id": {1296 "type": "number",1297 "description": "The unique identifier associated with the bag"1298 },1299 "state_id": {1300 "type": "number",1301 "description": "The unique identifier associated with the state"1302 },1303 "state_type": {1304 "type": "string",1305 "enum": [1306 "operational",1307 "logistics",1308 "financial"1309 ],1310 "description": "Type of the state - operational, logistics, financial"1311 },1312 "delivery_awb_number": {1313 "type": [1314 "string",1315 "null"1316 ],1317 "description": "Airway Bill (AWB) number associated with the delivery"1318 },1319 "bag_state_mapper": {1320 "type": "object",1321 "description": "Object representing properties of the state",1322 "properties": {1323 "journey_type": {1324 "type": [1325 "string",1326 "null"1327 ],1328 "enum": [1329 "forward",1330 "return"1331 ],1332 "description": "Journey type can be forward or return"1333 },1334 "app_display_name": {1335 "type": "string",1336 "description": "The display name of a shipment status as it appears on the sale channel's website"1337 },1338 "state_type": {1339 "type": "string",1340 "enum": [1341 "operational",1342 "logistics",1343 "financial"1344 ],1345 "description": "Type of the state - operational, logistics, financial"1346 },1347 "app_state_name": {1348 "type": "string",1349 "description": "The slug of a shipment status from the sale channel's front"1350 },1351 "name": {1352 "type": "string",1353 "description": "The slug of a shipment status from the platform's front"1354 },1355 "app_facing": {1356 "type": "boolean",1357 "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"1358 },1359 "id": {1360 "type": "number",1361 "description": "The unique identifier associated with the state"1362 },1363 "display_name": {1364 "type": "string",1365 "description": "The display name of a shipment status as it appears on the platform"1366 },1367 "is_active": {1368 "type": "boolean",1369 "description": "A boolean flag indicating whether a state is active or not"1370 }1371 },1372 "required": [1373 "journey_type",1374 "app_display_name",1375 "state_type",1376 "app_state_name",1377 "name",1378 "app_facing",1379 "id",1380 "display_name",1381 "is_active"1382 ]1383 },1384 "reasons": {1385 "type": "array",1386 "items": {1387 "type": "object",1388 "properties": {1389 "slug": {1390 "type": "string",1391 "description": "System generated slug"1392 },1393 "display_name": {1394 "type": "string",1395 "description": "Text that is displayed on the application front"1396 },1397 "id": {1398 "type": "integer",1399 "description": "System generated ID of the reason object"1400 },1401 "state": {1402 "type": [1403 "integer",1404 "string"1405 ],1406 "description": "State associated with the reason"1407 },1408 "text": {1409 "type": "string",1410 "description": "Reason text"1411 },1412 "quantity": {1413 "type": "integer",1414 "description": "No of quantity that is being cancelled"1415 },1416 "inventory_flag": {1417 "type": "boolean",1418 "description": "Inventory depletion action to be taken or not"1419 }1420 }1421 },1422 "description": "Reasons associated with the current shipment's status"1423 },1424 "action_user": {1425 "description": "Details of the user who initiated the change in the shipment's status",1426 "required": [],1427 "type": "object",1428 "properties": {1429 "title": {1430 "type": "string",1431 "description": "The title of the user eg. Staff, Admin",1432 "example": "Staff"1433 },1434 "user_id": {1435 "type": "string",1436 "description": "System generated ID associated with the user",1437 "example": "23546659"1438 },1439 "user_name": {1440 "type": "string",1441 "description": "System generated username associated with the user",1442 "example": "65967faf620ff7c9db513d9c"1443 },1444 "order_role": {1445 "type": "string",1446 "description": "Order role associated with the user eg. company_operation, store_manager",1447 "example": "full_access"1448 },1449 "employee_code": {1450 "type": "string",1451 "x-not-enum": true,1452 "description": "Employee code associated with the user",1453 "example": "EM-102"1454 }1455 }1456 }1457 },1458 "required": [1459 "created_at",1460 "created_ts",1461 "id",1462 "kafka_sync",1463 "updated_ts",1464 "updated_at",1465 "delivery_partner_id",1466 "shipment_id",1467 "store_id",1468 "status",1469 "bag_id",1470 "state_id",1471 "state_type",1472 "delivery_awb_number",1473 "bag_state_mapper",1474 "reasons",1475 "action_user"1476 ]1477 },1478 "affiliate_bag_details": {1479 "type": "object",1480 "description": "Object containing external bag details like external order id, external bag id",1481 "properties": {1482 "affiliate_bag_id": {1483 "type": "string",1484 "description": "External bag id"1485 },1486 "affiliate_order_id": {1487 "type": "string",1488 "description": "External order id"1489 }1490 },1491 "required": [1492 "affiliate_bag_id",1493 "affiliate_order_id"1494 ]1495 },1496 "payment_methods": {1497 "type": "object",1498 "description": "\"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details.\""1499 },1500 "quantity": {1501 "type": "number",1502 "description": "Total quantity of the article present in the bag."1503 },1504 "prices": {1505 "type": "object",1506 "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",1507 "properties": {1508 "price_effective": {1509 "type": "number",1510 "description": "MRP - Initial Seller provided discount"1511 },1512 "discount": {1513 "type": "number",1514 "description": "The total amount discounted from the original MRP/actual price"1515 },1516 "amount_paid": {1517 "type": "number",1518 "description": "Amount paid by the customer"1519 },1520 "coupon_effective_discount": {1521 "type": "number",1522 "description": "Coupon provided by brand or seller"1523 },1524 "delivery_charge": {1525 "type": "number",1526 "description": "The fee associated with the delivery service for transporting the item to its destination"1527 },1528 "fynd_credits": {1529 "type": "number",1530 "description": "Credits provided by Fynd"1531 },1532 "cod_charges": {1533 "type": "number",1534 "description": "The fee associated with the COD order"1535 },1536 "refund_credit": {1537 "type": "number",1538 "description": "Refund credits provided to the customer"1539 },1540 "cashback": {1541 "type": "number",1542 "description": "Cashback points"1543 },1544 "refund_amount": {1545 "type": "number",1546 "description": "Amount to be refunded on cancellation and return"1547 },1548 "added_to_fynd_cash": {1549 "type": "boolean",1550 "description": "Flag indicating whether fynd cash has been used"1551 },1552 "cashback_applied": {1553 "type": "number",1554 "description": "Cashback applied on the order"1555 },1556 "gst_tax_percentage": {1557 "type": "number",1558 "description": "The percentage rate of GST applied to a product or service"1559 },1560 "value_of_good": {1561 "type": "number",1562 "description": "Effective selling price - Product GST Amount"1563 },1564 "price_marked": {1565 "type": "number",1566 "description": "The indicated price or value assigned to an item before any discounts or adjustments"1567 },1568 "transfer_price": {1569 "type": "number",1570 "description": "article"1571 },1572 "brand_calculated_amount": {1573 "type": "number",1574 "description": "Price Effective - Coupon Discount (Seller) - Promotion (Seller)"1575 },1576 "tax_collected_at_source": {1577 "type": "number",1578 "description": "The tax amount collected at the source of income or transaction"1579 },1580 "tcs_percentage": {1581 "type": "number",1582 "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"1583 },1584 "promotion_effective_discount": {1585 "type": "number",1586 "description": "Effective promotion discount including promotions given by seller and Platform"1587 },1588 "gift_price": {1589 "type": "number",1590 "description": "Gift card amount used"1591 },1592 "coupon_value": {1593 "type": "number",1594 "description": "Stores the coupon value as shown in the cart"1595 },1596 "seller_promotion_effective_discount": {1597 "type": "number",1598 "description": "Promotion discount given by the seller"1599 },1600 "fynd_promotion_effective_discount": {1601 "type": "number",1602 "description": "Promotion discount given by Platform/fynd"1603 },1604 "amount_paid_roundoff": {1605 "type": "number",1606 "description": "Amount paid rounded off"1607 },1608 "loyalty_discount": {1609 "type": "number",1610 "description": "Amount reduced from the payable price when the customer applies loyalty program points while placing the order"1611 }1612 },1613 "required": [1614 "price_effective",1615 "discount",1616 "amount_paid",1617 "coupon_effective_discount",1618 "delivery_charge",1619 "fynd_credits",1620 "cod_charges",1621 "refund_credit",1622 "cashback",1623 "refund_amount",1624 "added_to_fynd_cash",1625 "cashback_applied",1626 "gst_tax_percentage",1627 "value_of_good",1628 "price_marked",1629 "transfer_price",1630 "brand_calculated_amount",1631 "tax_collected_at_source",1632 "tcs_percentage",1633 "promotion_effective_discount",1634 "gift_price",1635 "coupon_value",1636 "seller_promotion_effective_discount",1637 "fynd_promotion_effective_discount",1638 "amount_paid_roundoff"1639 ]1640 },1641 "order_created": {1642 "type": "string",1643 "description": "Order creation timestamp"1644 },1645 "gst_details": {1646 "type": "object",1647 "description": "GST details associated with the bag",1648 "properties": {1649 "gstin_code": {1650 "type": [1651 "string",1652 "null"1653 ],1654 "x-not-enum": true,1655 "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"1656 },1657 "gst_tag": {1658 "type": [1659 "string",1660 "null"1661 ],1662 "description": "Type of GST applied - IGST, CGST, SGST"1663 },1664 "hsn_code": {1665 "type": [1666 "string",1667 "null"1668 ],1669 "x-not-enum": true,1670 "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"1671 },1672 "value_of_good": {1673 "type": "number",1674 "description": "Effective selling price - Product GST Amount"1675 },1676 "gst_tax_percentage": {1677 "type": "number",1678 "description": "The percentage rate of GST applied to a product or service"1679 },1680 "is_default_hsn_code": {1681 "type": "boolean"1682 },1683 "brand_calculated_amount": {1684 "type": "number",1685 "description": "Effective selling price - Brand's additional discounts"1686 },1687 "tax_collected_at_source": {1688 "type": "number",1689 "description": "The tax amount collected at the source of income or transaction"1690 },1691 "hsn_code_id": {1692 "type": [1693 "string",1694 "null"1695 ],1696 "description": "The unique identifier associated with HSN code"1697 },1698 "gst_fee": {1699 "type": "number",1700 "description": "The fee associated with Goods and Services Tax (GST) for a product or service"1701 },1702 "igst_tax_percentage": {1703 "type": "number",1704 "description": "Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions"1705 },1706 "sgst_tax_percentage": {1707 "type": "number",1708 "description": "Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state"1709 },1710 "cgst_tax_percentage": {1711 "type": "number",1712 "description": "Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state"1713 },1714 "igst_gst_fee": {1715 "type": [1716 "string",1717 "number"1718 ],1719 "description": "Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions"1720 },1721 "cgst_gst_fee": {1722 "type": "string",1723 "description": "Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state"1724 },1725 "sgst_gst_fee": {1726 "type": "string",1727 "description": "Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state"1728 },1729 "tax_rule_id": {1730 "type": "string",1731 "description": "ID of the tax rule associated with the product"1732 }1733 },1734 "required": [1735 "gstin_code",1736 "gst_tag",1737 "hsn_code",1738 "value_of_good",1739 "gst_tax_percentage",1740 "is_default_hsn_code",1741 "brand_calculated_amount",1742 "tax_collected_at_source",1743 "hsn_code_id",1744 "gst_fee",1745 "igst_tax_percentage",1746 "sgst_tax_percentage",1747 "cgst_tax_percentage",1748 "igst_gst_fee",1749 "cgst_gst_fee",1750 "sgst_gst_fee"1751 ]1752 },1753 "line_number": {1754 "type": "number",1755 "description": "Unique identifier associated with each bag in a shipment"1756 },1757 "applied_promos": {1758 "type": "array",1759 "description": "Details of the applied promotions",1760 "items": {1761 "type": "object",1762 "properties": {1763 "promo_id": {1764 "type": "string",1765 "description": "Promotion id"1766 },1767 "buy_rules": {1768 "description": "Buy rules for promotions",1769 "type": "array",1770 "items": {1771 "type": "object",1772 "properties": {1773 "item_criteria": {1774 "type": "object",1775 "description": "Item criteria of promotion"1776 },1777 "cart_conditions": {1778 "type": "object",1779 "description": "Cart conditions details for promotion"1780 }1781 }1782 }1783 },1784 "offer_text": {1785 "type": "string",1786 "description": "Offer text of current promotion"1787 },1788 "promotion_group": {1789 "type": "string",1790 "description": "Promotion group for the promotion"1791 },1792 "mrp_promotion": {1793 "type": "boolean",1794 "description": "If applied promotion is applied on product MRP or ESP"1795 },1796 "promotion_name": {1797 "type": "string",1798 "description": "Promotion name of current promotion"1799 },1800 "amount": {1801 "type": "number",1802 "description": "Per unit discount amount applied with current promotion"1803 },1804 "discount_rules": {1805 "description": "Discount rules for promotions",1806 "type": "array",1807 "items": {1808 "type": "object",1809 "properties": {1810 "matched_buy_rules": {1811 "type": "array",1812 "description": "Matched buy rules for promotion",1813 "items": {1814 "type": "string"1815 }1816 },1817 "raw_offer": {1818 "type": "object",1819 "description": "raw offer details for promotion"1820 },1821 "offer": {1822 "type": "object",1823 "description": "offer for promotion"1824 },1825 "item_criteria": {1826 "type": "object",1827 "description": "Item criteria of promotion"1828 }1829 }1830 }1831 },1832 "ownership": {1833 "type": "object",1834 "description": "Ownership of promotion",1835 "properties": {1836 "payable_category": {1837 "type": "string",1838 "x-not-enum": true,1839 "description": "promo amount payable category"1840 },1841 "payable_by": {1842 "type": "string",1843 "description": "promo amount bearable party"1844 }1845 }1846 },1847 "article_quantity": {1848 "type": "integer",1849 "description": "Quantity of article on which promotion is applicable"1850 },1851 "applied_free_articles": {1852 "description": "Applied free article for free gift item promotions",1853 "type": "array",1854 "items": {1855 "type": "object",1856 "properties": {1857 "free_gift_item_details": {1858 "description": "Free gift items details",1859 "type": "object",1860 "properties": {1861 "item_slug": {1862 "type": "string",1863 "description": "item slug"1864 },1865 "item_name": {1866 "type": "string",1867 "description": "Item name"1868 },1869 "item_price_details": {1870 "type": "object",1871 "description": "item price details"1872 },1873 "item_brand_name": {1874 "type": "string",1875 "description": "item brand name"1876 },1877 "item_id": {1878 "type": "integer",1879 "description": "Item id"1880 },1881 "item_images_url": {1882 "type": "array",1883 "description": "item images URL",1884 "items": {1885 "type": "string"1886 }1887 }1888 }1889 },1890 "parent_item_identifier": {1891 "type": "string",1892 "description": "Parent item identifier for free article"1893 },1894 "quantity": {1895 "type": "integer",1896 "description": "Free article quantity"1897 },1898 "article_id": {1899 "type": "string",1900 "description": "free article id"1901 }1902 }1903 }1904 },1905 "promotion_type": {1906 "type": "string",1907 "x-not-enum": true,1908 "description": "Promotion type of current promotion"1909 },1910 "meta": {1911 "type": "object",1912 "additionalProperties": true,1913 "description": "Meta object for extra data"1914 },1915 "code": {1916 "type": [1917 "string",1918 "null"1919 ],1920 "description": "Promotion code"1921 }1922 }1923 }1924 },1925 "taxes": {1926 "type": "array",1927 "description": "Details of taxes applied on products",1928 "items": {1929 "type": "object",1930 "properties": {1931 "name": {1932 "type": "string",1933 "description": "Name of the tax applied (e.g., GST, CGST, SGST, VAT)"1934 },1935 "rate": {1936 "type": "number",1937 "description": "Tax rate applied, represented as a decimal value (e.g., 0.09 for 9%)"1938 },1939 "taxable_amount": {1940 "type": "number",1941 "description": "Amount on which the tax is calculated, after applicable discounts or exemptions"1942 },1943 "tax_amount": {1944 "type": "number",1945 "description": "Final tax amount calculated using the tax rate on the taxable amount"1946 }1947 }1948 }1949 }1950 },1951 "required": [1952 "financial_breakup",1953 "entity_type",1954 "item",1955 "brand",1956 "bag_id",1957 "article",1958 "current_operational_status",1959 "affiliate_bag_details",1960 "payment_methods",1961 "quantity",1962 "prices",1963 "order_created",1964 "gst_details",1965 "line_number",1966 "applied_promos",1967 "taxes"1968 ]1969 }1970 },1971 "bag_status_history": {1972 "type": "array",1973 "description": "Records the changes in status for a bag, providing a timeline of events and transitions",1974 "items": {1975 "type": "object",1976 "properties": {1977 "created_at": {1978 "type": "string",1979 "format": "date-time",1980 "description": "Date and time when the bag status history record was created."1981 },1982 "created_ts": {1983 "type": "string",1984 "description": "Timestamp indicating the exact time when the bag status history record was created"1985 },1986 "id": {1987 "type": "number",1988 "description": "Unique identifier for the bag status history record"1989 },1990 "kafka_sync": {1991 "type": "boolean",1992 "description": "Flag indicating whether the bag status history update has been sync with Kafka"1993 },1994 "updated_ts": {1995 "type": "string",1996 "description": "Timestamp indicating the last time the bag status history record was updated"1997 },1998 "updated_at": {1999 "format": "date-time",2000 "type": "string",2001 "description": "Date and time of the most recent update to the bag status history record"2002 },2003 "delivery_partner_id": {2004 "type": [2005 "integer",2006 "null"2007 ],2008 "description": "Unique identifier of delivery partner"2009 },2010 "shipment_id": {2011 "type": "string",2012 "description": "Unique shipment no. that is auto-generated"2013 },2014 "store_id": {2015 "type": "number",2016 "description": "Store id associated with the bag"2017 },2018 "status": {2019 "type": "string",2020 "description": "Webhook shipment status, i.e., either create or update"2021 },2022 "bag_id": {2023 "type": "number",2024 "description": "The unique identifier associated with the bag"2025 },2026 "state_id": {2027 "type": "number",2028 "description": "The unique identifier associated with the state"2029 },2030 "state_type": {2031 "type": "string",2032 "enum": [2033 "operational",2034 "logistics",2035 "financial"2036 ],2037 "description": "Type of the state - operational, logistics, financial"2038 },2039 "delivery_awb_number": {2040 "type": [2041 "string",2042 "null"2043 ],2044 "description": "Airway Bill (AWB) number associated with the delivery"2045 },2046 "bag_state_mapper": {2047 "type": "object",2048 "description": "Object representing properties of the state",2049 "properties": {2050 "journey_type": {2051 "type": [2052 "string",2053 "null"2054 ],2055 "enum": [2056 "forward",2057 "return"2058 ],2059 "description": "Journey type can be forward or return"2060 },2061 "app_display_name": {2062 "type": "string",2063 "description": "The display name of a shipment status as it appears on the sale channel's website"2064 },2065 "state_type": {2066 "type": "string",2067 "enum": [2068 "operational",2069 "logistics",2070 "financial"2071 ],2072 "description": "Type of the state - operational, logistics, financial"2073 },2074 "app_state_name": {2075 "type": "string",2076 "description": "The slug of a shipment status from the sale channel's front"2077 },2078 "name": {2079 "type": "string",2080 "description": "The slug of a shipment status from the platform's front"2081 },2082 "app_facing": {2083 "type": "boolean",2084 "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"2085 },2086 "id": {2087 "type": "number",2088 "description": "The unique identifier associated with the state"2089 },2090 "display_name": {2091 "type": "string",2092 "description": "The display name of a shipment status as it appears on the platform"2093 },2094 "is_active": {2095 "type": "boolean",2096 "description": "A boolean flag indicating whether a state is active or not"2097 }2098 },2099 "required": [2100 "journey_type",2101 "app_display_name",2102 "state_type",2103 "app_state_name",2104 "name",2105 "app_facing",2106 "id",2107 "display_name",2108 "is_active"2109 ]2110 },2111 "reasons": {2112 "type": "array",2113 "items": {2114 "type": "object",2115 "properties": {2116 "slug": {2117 "type": "string",2118 "description": "System generated slug"2119 },2120 "display_name": {2121 "type": "string",2122 "description": "Text that is displayed on the application front"2123 },2124 "id": {2125 "type": "integer",2126 "description": "System generated ID of the reason object"2127 },2128 "state": {2129 "type": [2130 "integer",2131 "string"2132 ],2133 "description": "State associated with the reason"2134 },2135 "text": {2136 "type": "string",2137 "description": "Reason text"2138 },2139 "quantity": {2140 "type": "integer",2141 "description": "No of quantity that is being cancelled"2142 },2143 "inventory_flag": {2144 "type": "boolean",2145 "description": "Inventory depletion action to be taken or not"2146 }2147 }2148 },2149 "description": "Reasons associated with the current shipment's status"2150 },2151 "action_user": {2152 "type": "object",2153 "properties": {2154 "title": {2155 "type": "string",2156 "description": "The title of the user eg. Staff, Admin",2157 "example": "Staff"2158 },2159 "user_id": {2160 "type": "string",2161 "description": "System generated ID associated with the user",2162 "example": "23546659"2163 },2164 "user_name": {2165 "type": "string",2166 "description": "System generated username associated with the user",2167 "example": "65967faf620ff7c9db513d9c"2168 },2169 "order_role": {2170 "type": "string",2171 "description": "Order role associated with the user eg. company_operation, store_manager",2172 "example": "full_access"2173 },2174 "employee_code": {2175 "type": "string",2176 "x-not-enum": true,2177 "description": "Employee code associated with the user",2178 "example": "EM-102"2179 }2180 },2181 "required": []2182 }2183 },2184 "required": [2185 "created_at",2186 "created_ts",2187 "id",2188 "kafka_sync",2189 "updated_ts",2190 "updated_at",2191 "delivery_partner_id",2192 "shipment_id",2193 "store_id",2194 "status",2195 "bag_id",2196 "state_id",2197 "state_type",2198 "delivery_awb_number",2199 "bag_state_mapper",2200 "reasons",2201 "action_user"2202 ]2203 }2204 },2205 "fulfilling_store": {2206 "description": "Details of the store responsible for fulfilling the order",2207 "type": "object",2208 "properties": {2209 "id": {2210 "type": "number",2211 "description": "Unique identifier for the store."2212 },2213 "code": {2214 "type": "string",2215 "description": "Alphanumeric code representing the store."2216 },2217 "name": {2218 "type": "string",2219 "description": "Name of the store."2220 },2221 "address": {2222 "type": "string",2223 "description": "Physical address of the store."2224 },2225 "state": {2226 "type": "string",2227 "description": "State where the store is located."2228 },2229 "city": {2230 "type": "string",2231 "description": "City where the store is located."2232 },2233 "pincode": {2234 "type": "string",2235 "description": "Postal code (pincode) of the store's location."2236 },2237 "country": {2238 "type": "string",2239 "description": "Country where the store is situated."2240 },2241 "phone": {2242 "type": "string",2243 "description": "Contact phone number for the store."2244 },2245 "fulfillment_channel": {2246 "type": "string",2247 "description": "Type of fulfillment channel used by the store."2248 },2249 "location_type": {2250 "type": "string",2251 "enum": [2252 "high_street",2253 "mall",2254 "store",2255 "warehouse"2256 ],2257 "description": "Type of location e.g., warehouse, high_street"2258 },2259 "company_id": {2260 "type": "number",2261 "description": "Identifier of the company responsible for fulfilling shipments from this store"2262 },2263 "is_active": {2264 "type": "boolean",2265 "description": "Boolean indicating whether the store is currently active"2266 },2267 "tags": {2268 "type": "array",2269 "items": {2270 "type": "string"2271 },2272 "description": "Array of tags associated with the store"2273 }2274 },2275 "required": [2276 "id",2277 "code",2278 "name",2279 "address",2280 "state",2281 "city",2282 "pincode",2283 "country",2284 "phone",2285 "fulfillment_channel",2286 "location_type",2287 "company_id",2288 "is_active",2289 "tags"2290 ]2291 },2292 "prices": {2293 "type": "object",2294 "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",2295 "properties": {2296 "amount_paid": {2297 "type": "number",2298 "description": "Amount paid by the customer"2299 },2300 "refund_amount": {2301 "type": "number",2302 "description": "Amount to be refunded on cancellation and return"2303 },2304 "price_marked": {2305 "type": "number",2306 "description": "The indicated price or value assigned to an item before any discounts or adjustments"2307 },2308 "cod_charges": {2309 "type": "number",2310 "description": "The fee associated with the COD order"2311 },2312 "discount": {2313 "type": "number",2314 "description": "The total amount discounted from the original MRP/actual price"2315 },2316 "cashback_applied": {2317 "type": "number",2318 "description": "Cashback applied on the order"2319 },2320 "delivery_charge": {2321 "type": "number",2322 "description": "The fee associated with the delivery service for transporting the item to its destination"2323 },2324 "fynd_credits": {2325 "type": "number",2326 "description": "Credits provided by Fynd"2327 },2328 "cashback": {2329 "type": "number",2330 "description": "Cashback points"2331 },2332 "price_effective": {2333 "type": "number",2334 "description": "MRP - Initial Seller provided discount"2335 },2336 "refund_credit": {2337 "type": "number",2338 "description": "Refund credits provided to the customer"2339 },2340 "value_of_good": {2341 "type": "number",2342 "description": "Effective selling price - Product GST Amount"2343 },2344 "coupon_value": {2345 "type": "number",2346 "description": "Stores the coupon value as shown in the cart"2347 },2348 "tax_collected_at_source": {2349 "type": "number",2350 "description": "The tax amount collected at the source of income or transaction"2351 },2352 "promotion_effective_discount": {2353 "type": "number",2354 "description": "Effective promotion discount including promotions given by seller and Platform"2355 },2356 "fynd_promotion_effective_discount": {2357 "type": "number",2358 "description": "Promotion discount given by Platform/fynd"2359 },2360 "seller_promotion_effective_discount": {2361 "type": "number",2362 "description": "Promotion discount given by the seller"2363 },2364 "cn_refund_amount": {2365 "type": "number",2366 "description": "Amount to be refunded through credit note"2367 },2368 "gift_price": {2369 "type": "number",2370 "description": "Gift card amount used"2371 },2372 "amount_paid_roundoff": {2373 "type": "number",2374 "description": "Amount paid rounded off"2375 },2376 "loyalty_discount": {2377 "type": "number",2378 "description": "Amount reduced from the payable price when the customer applies loyalty program points while placing the order"2379 }2380 },2381 "required": [2382 "amount_paid",2383 "refund_amount",2384 "price_marked",2385 "cod_charges",2386 "discount",2387 "cashback_applied",2388 "delivery_charge",2389 "fynd_credits",2390 "cashback",2391 "price_effective",2392 "refund_credit",2393 "value_of_good",2394 "coupon_value",2395 "tax_collected_at_source",2396 "promotion_effective_discount",2397 "fynd_promotion_effective_discount",2398 "seller_promotion_effective_discount",2399 "cn_refund_amount",2400 "gift_price"2401 ]2402 },2403 "payments": {2404 "type": "object",2405 "description": "Object containing payment mode and payment breakup",2406 "properties": {2407 "id": {2408 "type": "number",2409 "description": "Unique identifier for the payment mode"2410 },2411 "mode": {2412 "type": "string",2413 "description": "Type or category of the payment mode (e.g., PP, COD)"2414 },2415 "logo": {2416 "type": "string",2417 "description": "URL or path to the logo/icon representing the payment mode"2418 },2419 "display_name": {2420 "type": "string",2421 "description": "Name or label used to display the payment mode"2422 },2423 "display_priority": {2424 "type": "number",2425 "description": "Priority order for displaying the payment mode"2426 },2427 "source": {2428 "type": "string",2429 "description": "Merchant of the payment mode (e.g., PartnerPay, JioPp)"2430 },2431 "is_active": {2432 "type": "boolean",2433 "description": "Boolean indicating whether the payment mode is currently active"2434 }2435 },2436 "required": [2437 "id",2438 "mode",2439 "logo",2440 "display_name",2441 "display_priority",2442 "source",2443 "is_active"2444 ]2445 },2446 "affiliate_details": {2447 "type": "object",2448 "description": "Application related details like config, order_id, shipment id",2449 "properties": {2450 "id": {2451 "type": [2452 "string",2453 "number"2454 ],2455 "description": "Identifier for the application, can be application_id or extension_id"2456 },2457 "affiliate_bag_id": {2458 "type": "string",2459 "description": "Identifier assigned by the application for the bag"2460 },2461 "affiliate_order_id": {2462 "type": "string",2463 "description": "Identifier of the order assigned by the application"2464 },2465 "company_affiliate_tag": {2466 "type": "string",2467 "description": "Tag associated with the bag from the application's company"2468 },2469 "affiliate_id": {2470 "type": "string",2471 "description": "Identifier for the application, can be application_id or extension_id"2472 },2473 "affiliate_shipment_id": {2474 "type": "string",2475 "description": "Identifier of the shipment assigned by the application"2476 },2477 "affiliate_store_id": {2478 "type": "string",2479 "description": "Identifier of the store assigned by the application"2480 },2481 "pdf_links": {2482 "type": "object",2483 "description": "PDF Links pushed by the application or extension",2484 "properties": {2485 "label_type": {2486 "type": "string",2487 "description": "Label type - external"2488 },2489 "invoice_type": {2490 "type": "string",2491 "description": "Invoice type - external"2492 },2493 "label": {2494 "type": "string",2495 "description": "Label URL provided by the application or extension"2496 },2497 "invoice": {2498 "type": "string",2499 "description": "Invoice URL provided by the application or extension"2500 }2501 },2502 "required": [2503 "label_type",2504 "invoice_type"2505 ]2506 },2507 "config": {2508 "type": "object",2509 "description": "Application configuration details",2510 "properties": {2511 "id": {2512 "type": [2513 "string",2514 "number"2515 ],2516 "description": "Identifier for the application, can be application_id or extension_id"2517 },2518 "name": {2519 "type": "string",2520 "description": "Application name"2521 },2522 "token": {2523 "type": [2524 "null",2525 "string"2526 ],2527 "description": "Application token - deprecated"2528 },2529 "dp_assignment": {2530 "type": "boolean",2531 "description": "Flag indicating whether auto DP assignment should happen from system"2532 },2533 "app_company_id": {2534 "type": [2535 "number",2536 "null",2537 "string"2538 ],2539 "description": "ID of the company from which order was placed"2540 },2541 "article_assignment": {2542 "description": "The article assignment settings",2543 "type": "object",2544 "properties": {2545 "strategy": {2546 "type": "string",2547 "enum": [2548 "optimal",2549 "low-price"2550 ]2551 },2552 "level": {2553 "type": "string",2554 "enum": [2555 "multi-companies",2556 "single-company",2557 "single-store"2558 ]2559 }2560 },2561 "required": []2562 },2563 "force_reassignment": {2564 "type": "boolean",2565 "description": "Indicates whether force reassignment is enabled"2566 },2567 "sales_channel_logo": {2568 "type": "string",2569 "description": "Logo URL of the application to which order belongs"2570 },2571 "ordering_channel_logo": {2572 "type": "string",2573 "description": "Logo URL of the ordering channel"2574 },2575 "post_order_reassignment": {2576 "type": "boolean",2577 "description": "Indicates whether post-order reassignment is enabled"2578 }2579 }2580 }2581 },2582 "required": [2583 "id",2584 "affiliate_bag_id",2585 "affiliate_order_id",2586 "company_affiliate_tag",2587 "affiliate_id",2588 "affiliate_shipment_id",2589 "affiliate_store_id",2590 "pdf_links",2591 "config"2592 ]2593 },2594 "dp_details": {2595 "type": "object",2596 "description": "Delivery Partner details",2597 "properties": {2598 "id": {2599 "type": [2600 "string",2601 "number",2602 "null"2603 ],2604 "description": "Unique identifier for the delivery partner"2605 },2606 "name": {2607 "type": [2608 "string",2609 "null"2610 ],2611 "description": "Name of the delivery partner"2612 },2613 "awb_no": {2614 "type": [2615 "string",2616 "null"2617 ],2618 "description": "Airway Bill (AWB) number associated with the delivery"2619 },2620 "eway_bill_id": {2621 "type": [2622 "string",2623 "null"2624 ],2625 "description": "Electronic Way Bill (E-way Bill) ID for the delivery"2626 },2627 "track_url": {2628 "type": [2629 "string",2630 "null"2631 ],2632 "description": "URL to track the delivery status or shipment details"2633 },2634 "gst_tag": {2635 "type": [2636 "string",2637 "null"2638 ],2639 "description": "GST tag of the shipment"2640 },2641 "extension_id": {2642 "type": [2643 "string",2644 "null"2645 ],2646 "description": "Unique Identifier of Courier partner Extension"2647 },2648 "scheme_id": {2649 "type": [2650 "string",2651 "null"2652 ],2653 "description": "Unique identifier of a Courier partner scheme"2654 },2655 "courier_partner_slug": {2656 "type": [2657 "string",2658 "null"2659 ],2660 "description": "Unique identifier containing extension_id and scheme_id"2661 }2662 },2663 "required": [2664 "id",2665 "name",2666 "awb_no",2667 "eway_bill_id",2668 "track_url",2669 "gst_tag",2670 "extension_id",2671 "scheme_id",2672 "courier_partner_slug"2673 ]2674 },2675 "rto_address": {2676 "type": "object",2677 "description": "The address to which shipment should be delivered in case of RTO",2678 "properties": {2679 "company_id": {2680 "type": "number",2681 "description": "ID of the company fulfilling the shipment"2682 },2683 "id": {2684 "type": "number",2685 "description": "ID of the store where RTO should happen"2686 },2687 "name": {2688 "type": "string",2689 "description": "A string representing the store's name"2690 },2691 "store_address_json": {2692 "type": "object",2693 "description": "Store address details",2694 "properties": {2695 "version": {2696 "type": "string",2697 "description": "Address version, to be deprecated"2698 },2699 "contact_person": {2700 "type": "string",2701 "description": "Name of the contact person associated with the address"2702 },2703 "address": {2704 "type": "string",2705 "description": "\"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""2706 },2707 "address1": {2708 "type": "string",2709 "description": "\"A string representing the first line of the address, typically containing street or building information\""2710 },2711 "address2": {2712 "type": "string",2713 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""2714 },2715 "name": {2716 "type": "string",2717 "description": "A string representing the store's name"2718 },2719 "area": {2720 "type": "string",2721 "description": "A string specifying the locality or area associated with the address"2722 },2723 "area_code": {2724 "type": "string",2725 "x-not-enum": true,2726 "description": "Area code of the address"2727 },2728 "area_code_slug": {2729 "type": "string",2730 "description": "Unique identifier or slug for the area code associated with the address"2731 },2732 "landmark": {2733 "type": "string",2734 "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""2735 },2736 "city": {2737 "type": "string",2738 "description": "A string denoting the city or municipality of the address"2739 },2740 "state": {2741 "type": "string",2742 "description": "A string indicating the state or province of the address"2743 },2744 "country": {2745 "type": "string",2746 "description": "A string indicating the country of the address"2747 },2748 "pincode": {2749 "type": "string",2750 "description": "A string indicating the postal code or PIN code of the address area"2751 },2752 "longitude": {2753 "type": [2754 "number",2755 "string"2756 ],2757 "description": "The longitude of the address"2758 },2759 "sector": {2760 "type": "string",2761 "description": "A string specifying the sector or district of the address if applicable"2762 },2763 "latitude": {2764 "type": [2765 "number",2766 "string"2767 ],2768 "description": "The latitude of the address"2769 },2770 "phone": {2771 "type": "string",2772 "description": "Mobile phone number of recipient associated with the address"2773 },2774 "email": {2775 "type": "string",2776 "description": "Email of the recipient associated with the address"2777 },2778 "address_type": {2779 "type": "string",2780 "x-not-enum": true,2781 "description": "Type of address (e.g., home, office, registered)"2782 },2783 "address_category": {2784 "type": "string",2785 "x-not-enum": true,2786 "description": "Category or classification of the address"2787 },2788 "created_at": {2789 "type": "string",2790 "format": "date-time",2791 "description": "Date and time when the address was created"2792 },2793 "updated_at": {2794 "type": "string",2795 "format": "date-time",2796 "description": "Date and time when the address was last updated"2797 },2798 "country_phone_code": {2799 "type": [2800 "string",2801 "null"2802 ],2803 "x-not-enum": true,2804 "description": "Phone code for the country of the address"2805 },2806 "country_iso_code": {2807 "type": "string",2808 "x-not-enum": true,2809 "description": "ISO code representing the country of the address"2810 },2811 "country_code": {2812 "type": "string",2813 "x-not-enum": true,2814 "description": "ISO code representing the country of the address"2815 },2816 "display_address": {2817 "type": "string",2818 "description": "Formatted display version of the address"2819 }2820 }2821 },2822 "code": {2823 "type": "string",2824 "description": "Alphanumeric code representing the store"2825 },2826 "location_type": {2827 "type": "string",2828 "x-not-enum": true,2829 "description": "Type of location e.g., warehouse, high_street"2830 },2831 "address1": {2832 "type": "string",2833 "description": "\"A string representing the first line of the address, typically containing street or building information\""2834 },2835 "address2": {2836 "type": "string",2837 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""2838 },2839 "display_address": {2840 "type": "string",2841 "description": "Formatted display version of the address"2842 },2843 "city": {2844 "type": "string",2845 "description": "A string denoting the city or municipality of the address"2846 },2847 "state": {2848 "type": "string",2849 "description": "A string indicating the state or province of the address"2850 },2851 "sector": {2852 "type": "string",2853 "description": "A string specifying the sector or district of the address if applicable"2854 },2855 "country": {2856 "type": "string",2857 "description": "A string indicating the country of the address"2858 },2859 "pincode": {2860 "type": "string",2861 "description": "A string indicating the postal code or PIN code of the address area"2862 },2863 "store_email": {2864 "type": "string",2865 "description": "Email of the recipient associated with the store"2866 },2867 "contact_person": {2868 "type": "string",2869 "description": "Name of the contact person associated with the address"2870 },2871 "phone": {2872 "type": "string",2873 "description": "Mobile phone number of recipient associated with the address"2874 }2875 },2876 "required": [2877 "company_id",2878 "id",2879 "name",2880 "store_address_json",2881 "code",2882 "location_type",2883 "address1",2884 "address2",2885 "display_address",2886 "city",2887 "state",2888 "sector",2889 "country",2890 "pincode",2891 "store_email",2892 "contact_person",2893 "phone"2894 ]2895 },2896 "weight": {2897 "type": "object",2898 "description": "Shipment weight",2899 "properties": {2900 "value": {2901 "type": "number"2902 },2903 "unit": {2904 "type": "string"2905 }2906 },2907 "required": [2908 "value",2909 "unit"2910 ]2911 },2912 "shipment_gst": {2913 "type": "object",2914 "description": "GST details associated with the shipment",2915 "properties": {2916 "value_of_good": {2917 "type": "number",2918 "description": "Effective selling price - Product GST Amount"2919 },2920 "gst_fee": {2921 "type": "number",2922 "description": "The fee associated with Goods and Services Tax (GST) for a product or service"2923 },2924 "brand_calculated_amount": {2925 "type": "number",2926 "description": "Effective selling price - Brand's additional discounts"2927 },2928 "tax_collected_at_source": {2929 "type": "number",2930 "description": "The tax amount collected at the source of income or transaction"2931 },2932 "gstin_code": {2933 "type": [2934 "string",2935 "null"2936 ],2937 "x-not-enum": true,2938 "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"2939 }2940 },2941 "required": [2942 "value_of_good",2943 "gst_fee",2944 "brand_calculated_amount",2945 "tax_collected_at_source",2946 "gstin_code"2947 ]2948 },2949 "store_invoice_id": {2950 "type": [2951 "string",2952 "null"2953 ],2954 "description": "Invoice ID attached to the shipment"2955 },2956 "credit_note_id": {2957 "type": [2958 "string",2959 "null"2960 ],2961 "description": "Credit Note ID attached to the shipment"2962 },2963 "order_created": {2964 "type": "string",2965 "description": "Order creation timestamp"2966 },2967 "payment_methods": {2968 "type": "object",2969 "description": "\"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details.\""2970 },2971 "payment_info": {2972 "type": "array",2973 "description": "\"Array of object containing payment methods used for placing an order.\"",2974 "items": {}2975 },2976 "order": {2977 "type": "object",2978 "description": "Order level details",2979 "properties": {2980 "ordering_channel": {2981 "type": "string",2982 "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."2983 },2984 "ordering_source": {2985 "type": "string",2986 "nullable": true,2987 "description": "To uniquely identify the source through which order has been placed."2988 },2989 "affiliate_order_date": {2990 "type": [2991 "string",2992 "null"2993 ],2994 "format": "date-time",2995 "description": "Order creation timestamp at application/extension end"2996 },2997 "affiliate_order_id": {2998 "type": "string",2999 "description": "Identifier of the order assigned by the application"3000 },3001 "fynd_order_id": {3002 "type": "string",3003 "description": "System generated unique identifier of the order"3004 },3005 "mode_of_payment": {3006 "type": "string",3007 "description": "Unique identifier associated with the payment mode"3008 },3009 "source": {3010 "type": "string",3011 "description": "Ordering source eg. affiliate, fynd"3012 },3013 "total_order_value": {3014 "type": "number",3015 "description": "Total order value"3016 },3017 "collect_by": {3018 "type": "string",3019 "description": "Whomsoever collected the money"3020 },3021 "refund_by": {3022 "type": "string",3023 "description": "Whomsoever will refund the money"3024 },3025 "order_value": {3026 "type": "number",3027 "description": "Value of the order"3028 },3029 "loyalty_discount_details": {3030 "type": "object",3031 "properties": {3032 "discount": {3033 "type": "number",3034 "description": "Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed"3035 },3036 "ownership": {3037 "type": "string",3038 "description": "Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace"3039 },3040 "is_applied": {3041 "type": "boolean",3042 "description": "Specifies whether the loyalty discount has been applied to the order"3043 }3044 },3045 "description": "Applied loyalty discount information"3046 }3047 },3048 "required": [3049 "ordering_channel",3050 "affiliate_order_date",3051 "affiliate_order_id",3052 "fynd_order_id",3053 "mode_of_payment",3054 "source",3055 "total_order_value",3056 "collect_by",3057 "refund_by",3058 "order_value"3059 ]3060 },3061 "order_source": {3062 "type": "string",3063 "description": "Ordering source eg. affiliate, fynd"3064 },3065 "journey_type": {3066 "type": [3067 "string",3068 "null"3069 ],3070 "description": "Journey type forward or return"3071 },3072 "einvoice_info": {3073 "type": "object",3074 "description": "Einvoice info if e-invoice is applicable",3075 "properties": {3076 "credit_note": {3077 "description": "Details of the reverse credit note einvoice",3078 "type": "object",3079 "properties": {3080 "ack_dt": {3081 "type": "string",3082 "description": "Date and time when the e-invoice acknowledgment was received"3083 },3084 "ack_no": {3085 "type": "string",3086 "description": "Acknowledgment number assigned to the e-invoice upon successful submission"3087 },3088 "irn": {3089 "type": "string",3090 "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"3091 },3092 "signed_invoice": {3093 "type": "string",3094 "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"3095 },3096 "signed_qr_code": {3097 "x-not-enum": true,3098 "type": "string",3099 "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"3100 },3101 "message": {3102 "type": "array",3103 "description": "Error Message received from JioGSt",3104 "items": {3105 "type": "object",3106 "properties": {3107 "ErrorCode": {3108 "type": [3109 "string",3110 "null"3111 ]3112 },3113 "ErrorMessage": {3114 "type": [3115 "string",3116 "null"3117 ]3118 }3119 }3120 }3121 }3122 }3123 },3124 "invoice": {3125 "description": "Details of the forward invoice einvoice",3126 "type": "object",3127 "properties": {3128 "ack_dt": {3129 "type": "string",3130 "description": "Date and time when the e-invoice acknowledgment was received"3131 },3132 "ack_no": {3133 "type": "string",3134 "description": "Acknowledgment number assigned to the e-invoice upon successful submission"3135 },3136 "irn": {3137 "type": "string",3138 "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"3139 },3140 "signed_invoice": {3141 "type": "string",3142 "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"3143 },3144 "signed_qr_code": {3145 "x-not-enum": true,3146 "type": "string",3147 "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"3148 },3149 "message": {3150 "type": "array",3151 "description": "Error Message received from JioGSt",3152 "items": {3153 "type": "object",3154 "properties": {3155 "ErrorCode": {3156 "type": [3157 "string",3158 "null"3159 ]3160 },3161 "ErrorMessage": {3162 "type": [3163 "string",3164 "null"3165 ]3166 }3167 }3168 }3169 }3170 }3171 }3172 },3173 "required": []3174 },3175 "lock_status": {3176 "type": "boolean",3177 "description": "Lock status of the shipment"3178 },3179 "original_bag_list": {3180 "type": "array",3181 "items": {3182 "type": "number"3183 },3184 "description": "List of Bag ids when the order was created"3185 },3186 "shipment_update_time": {3187 "type": "number",3188 "description": "Last shipment update time"3189 },3190 "previous_shipment_id": {3191 "type": [3192 "string",3193 "null"3194 ],3195 "description": "\"ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition\""3196 },3197 "fyndstore_emp": {3198 "type": "object",3199 "description": "Fynd store employee details",3200 "properties": {},3201 "required": []3202 },3203 "ordering_store": {3204 "description": "Store details from which order was placed in case of StoreOS",3205 "type": "object",3206 "properties": {3207 "id": {3208 "type": "number",3209 "description": "Unique identifier for the store."3210 },3211 "code": {3212 "type": "string",3213 "description": "Alphanumeric code representing the store."3214 },3215 "name": {3216 "type": "string",3217 "description": "Name of the store."3218 },3219 "address": {3220 "type": "string",3221 "description": "Physical address of the store."3222 },3223 "state": {3224 "type": "string",3225 "description": "State where the store is located."3226 },3227 "city": {3228 "type": "string",3229 "description": "City where the store is located."3230 },3231 "pincode": {3232 "type": "string",3233 "description": "Postal code (pincode) of the store's location."3234 },3235 "country": {3236 "type": "string",3237 "description": "Country where the store is situated."3238 },3239 "phone": {3240 "type": "string",3241 "description": "Contact phone number for the store."3242 },3243 "fulfillment_channel": {3244 "type": "string",3245 "description": "Type of fulfillment channel used by the store."3246 },3247 "location_type": {3248 "type": "string",3249 "enum": [3250 "high_street",3251 "mall",3252 "store",3253 "warehouse"3254 ],3255 "description": "Type of location e.g., warehouse, high_street"3256 },3257 "company_id": {3258 "type": "number",3259 "description": "Identifier of the company responsible for fulfilling shipments from this store"3260 },3261 "is_active": {3262 "type": "boolean",3263 "description": "Boolean indicating whether the store is currently active"3264 },3265 "tags": {3266 "type": "array",3267 "items": {3268 "type": "string"3269 },3270 "description": "Array of tags associated with the store"3271 }3272 },3273 "required": []3274 },3275 "coupon": {3276 "type": "object",3277 "description": "Coupon related details",3278 "properties": {},3279 "required": []3280 },3281 "cart_info": {3282 "type": "object",3283 "description": "Cart related information",3284 "properties": {3285 "cart_id": {3286 "type": "string",3287 "description": "The unique identifier of the cart"3288 },3289 "cart_uid": {3290 "type": "number",3291 "description": "UID associated with the cart"3292 }3293 },3294 "required": [3295 "cart_id",3296 "cart_uid"3297 ]3298 }3299 },3300 "required": [3301 "status",3302 "shipment_status",3303 "application_id",3304 "shipment_id",3305 "company_id",3306 "app_company_id",3307 "order_id",3308 "merchant_id",3309 "user",3310 "delivery_address",3311 "billing_address",3312 "delivery_partner_details",3313 "bags",3314 "bag_status_history",3315 "fulfilling_store",3316 "prices",3317 "payments",3318 "affiliate_details",3319 "dp_details",3320 "rto_address",3321 "weight",3322 "shipment_gst",3323 "store_invoice_id",3324 "credit_note_id",3325 "order_created",3326 "payment_methods",3327 "payment_info",3328 "order",3329 "order_source",3330 "journey_type",3331 "einvoice_info",3332 "lock_status",3333 "original_bag_list",3334 "shipment_update_time",3335 "previous_shipment_id",3336 "fyndstore_emp",3337 "ordering_store",3338 "coupon",3339 "cart_info"3340 ]3341 }3342 },3343 "required": [3344 "shipment"3345 ]3346 }3347 }3348}
Payload Example
1{2 "event": {3 "trace_id": [4 "00000000000000003f560c25eb5a6b2d"5 ],6 "name": "shipment",7 "type": "create",8 "version": "1",9 "created_timestamp": 1712229384850,10 "id": "LFdXAVR0SRDTgZ3xOZpv0MSiNFgY7lJlvT2/HehFieI=",11 "category": "application"12 },13 "company_id": 6367,14 "application_id": "63f893a94adb0bbd79de0344",15 "contains": [16 "shipment"17 ],18 "payload": {19 "shipment": {20 "status": "placed",21 "shipment_status": {22 "meta": {23 "request_meta": {},24 "estimated_sla_ts": "2024-04-05T00:46:23Z",25 "estimated_sla_time": "2024-04-05T00:46:23+00:00",26 "state_manager_used": "entity"27 },28 "created_at": "2024-04-04T16:46:25+00:00",29 "status": "placed",30 "updated_ts": "2024-04-04T11:16:24Z",31 "bag_list": [32 "33938213"33 ],34 "shipment_id": "17122293845391234896",35 "id": 164733749,36 "created_ts": "2024-04-04T11:16:24Z",37 "current_shipment_status": "placed",38 "status_created_at": "2024-04-04T16:46:25+00:00"39 },40 "application_id": "63f893a94adb0bbd79de0344",41 "shipment_id": "17122293845391234896",42 "company_id": 6367,43 "app_company_id": 6367,44 "order_id": "FYMP660E8C0801AD7F2D",45 "merchant_id": "",46 "user": {47 "meta": {48 "country_phone_code": ""49 },50 "email": "test@example.com",51 "gender": null,52 "mongo_user_id": null,53 "last_name": "",54 "mobile": "1111111111",55 "user_oid": null,56 "external_customer_id": null,57 "first_name": "Test user",58 "id": 18917956,59 "country_phone_code": "",60 "is_anonymous_user": false61 },62 "delivery_address": {63 "area": "",64 "city": "Jamnagar",65 "name": "test user ",66 "email": "test@example.com",67 "phone": "1111111111",68 "state": "Gujarat",69 "address": " test address",70 "country": "India",71 "pincode": "361005",72 "user_id": 18917956,73 "version": "1.0",74 "address1": "test address",75 "address2": "",76 "landmark": "",77 "latitude": 0,78 "area_code": "",79 "last_name": "",80 "longitude": 0,81 "created_at": "2024-04-04T16:46:24+00:00",82 "first_name": "dummy user",83 "updated_at": "2024-04-04T16:46:24+00:00",84 "address_type": "home",85 "geo_location": {},86 "area_code_slug": "",87 "contact_person": "dummy address",88 "address_category": "",89 "country_iso_code": "IN",90 "country_phone_code": null91 },92 "billing_address": {93 "area": "",94 "city": "Jamnagar",95 "name": "",96 "email": "test@example.com",97 "phone": "1111111111",98 "state": "Gujarat",99 "address": "test address",100 "country": "India",101 "pincode": "361005",102 "version": "1.0",103 "address1": "test address",104 "address2": "",105 "landmark": "",106 "latitude": 0,107 "area_code": "",108 "last_name": "",109 "longitude": 0,110 "created_at": "2024-04-04 16:46:24",111 "first_name": "dummy user",112 "updated_at": "2024-04-04 16:46:24",113 "address_type": "home",114 "geo_location": {},115 "area_code_slug": "",116 "contact_person": "test user",117 "display_address": "test address",118 "address_category": "",119 "country_iso_code": "IN",120 "country_phone_code": null121 },122 "delivery_partner_details": {123 "id": null,124 "name": null,125 "awb_no": null,126 "eway_bill_id": null,127 "track_url": null,128 "gst_tag": "sgst",129 "extension_id": null,130 "scheme_id": null,131 "courier_partner_slug": null132 },133 "bags": [134 {135 "financial_breakup": [136 {137 "brand_calculated_amount": 130,138 "discount": 69,139 "gst_fee": 19.83,140 "gst_tax_percentage": 18,141 "gst_tag": "SGST",142 "hsn_code": "33061020",143 "identifiers": {144 "sku_code": "BOTOOTHPASTE_50GM"145 },146 "price_marked": 199,147 "tax_collected_at_source": 0,148 "tcs_percentage": 0,149 "total_units": 1,150 "value_of_good": 110.17,151 "item_name": "Baby Organo Kids Toothpaste Strawberry 50g (0-6 Years)",152 "size": "1"153 }154 ],155 "entity_type": "bag",156 "item": {157 "webstore_product_url": null,158 "last_updated_at": "2024-04-04T16:31:44+00:00",159 "attributes": {160 "name": "Baby Organo Kids Toothpaste Strawberry 50g (0-6 Years)",161 "gender": [162 "Unisex"163 ],164 "essential": "No",165 "brand_name": "Generic",166 "net-quantity": "1 N",167 "marketer-name": "NATUREOVEDIC CONSUMERS PRIVATE LIMITED",168 "primary_color": "Black",169 "marketer-address": "dummy address",170 "primary_color_hex": "000000",171 "primary-colour-hex-code": "000000",172 "media": []173 },174 "l2_category": [175 "Baby Care"176 ],177 "name": "Baby Organo Kids Toothpaste Strawberry 50g (0-6 Years)",178 "l1_category": [179 "Kids Essentials"180 ],181 "gender": null,182 "l3_category": 1488,183 "brand_id": 5989,184 "brand": "Generic",185 "l3_category_name": "Baby Care Gift Sets",186 "l2_category_id": 560,187 "code": "RVWH9ES7KS",188 "meta": {189 "tags": [],190 "departments": [191 7192 ]193 },194 "slug_key": "baby-organo-kids-toothpaste-strawberry-50g-0-6-years-9917436",195 "can_cancel": true,196 "can_return": true,197 "color": null,198 "l1_category_id": 554,199 "id": 9917436,200 "branch_url": null,201 "department_id": 7,202 "size": "1",203 "image": [204 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/common/default_item_image.jpg"205 ]206 },207 "brand": {208 "is_virtual_invoice": false,209 "credit_note_allowed": false,210 "brand_name": "Generic",211 "modified_on": "2023-06-20T19:00:36+00:00",212 "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/square-logo/original/AogxD7pYK-Logo.png",213 "id": 5989,214 "created_on": "2023-05-24T05:34:01+00:00"215 },216 "bag_id": 33938213,217 "article": {218 "identifiers": {219 "sku_code": "BOTOOTHPASTE_50GM"220 },221 "esp_modified": "",222 "size": "1",223 "code": "",224 "raw_meta": null,225 "set": {},226 "is_set": "",227 "seller_identifier": "BOTOOTHPASTE_50GM",228 "return_config": {229 "time": 1,230 "unit": "days",231 "returnable": true232 },233 "_id": "659fe876fc7c748f7333b086",234 "uid": "659fe876fc7c748f7333b086",235 "child_details": {},236 "dimensions": {},237 "weight": {},238 "currency": {},239 "expiration_date": null240 },241 "current_operational_status": {242 "delivery_awb_number": null,243 "bag_id": 33938213,244 "created_at": "2024-04-04T16:46:25+00:00",245 "status": "placed",246 "state_id": 1,247 "updated_ts": "2024-04-04T11:16:24Z",248 "delivery_partner_id": null,249 "shipment_id": "17122293845391234896",250 "id": 217656545,251 "state_type": "operational",252 "updated_at": "2024-04-04T16:46:25+00:00",253 "created_ts": "2024-04-04T11:16:24Z",254 "store_id": 22665,255 "kafka_sync": false,256 "bag_state_mapper": {257 "journey_type": "forward",258 "app_display_name": "Processing",259 "state_type": "operational",260 "app_state_name": "processing",261 "name": "placed",262 "app_facing": true,263 "id": 1,264 "display_name": "Placed",265 "notify_customer": true,266 "is_active": true267 },268 "reasons": [],269 "action_user": {}270 },271 "affiliate_bag_details": {272 "affiliate_bag_id": "17122293829511256932J-1",273 "affiliate_order_id": "17122293670136786A",274 "affiliate_meta": {275 "fynd": {276 "fulfilment_identifier": "pulse",277 "fulfilment_identifiers_list": [278 "pulse"279 ]280 },281 "channel_shipment_id": null,282 "channel_order_id": null,283 "due_date": null,284 "is_priority": false,285 "box_type": null,286 "coupon_code": null,287 "size_level_total_qty": null,288 "loyalty_discount": 0,289 "employee_discount": 0290 },291 "loyalty_discount": 0,292 "employee_discount": 0293 },294 "payment_methods": {295 "COD": {296 "amount": 130297 }298 },299 "quantity": 1,300 "prices": {301 "price_effective": 130,302 "discount": 69,303 "amount_paid": 130,304 "coupon_effective_discount": 0,305 "delivery_charge": 0,306 "fynd_credits": 0,307 "cod_charges": 0,308 "refund_credit": 0,309 "cashback": 0,310 "refund_amount": 130,311 "added_to_fynd_cash": false,312 "cashback_applied": 0,313 "gst_tax_percentage": 18,314 "value_of_good": 110.17,315 "price_marked": 199,316 "transfer_price": 0,317 "brand_calculated_amount": 130,318 "tax_collected_at_source": 0,319 "tcs_percentage": 0,320 "promotion_effective_discount": 0,321 "gift_price": 0,322 "coupon_value": 0,323 "seller_promotion_effective_discount": 0,324 "fynd_promotion_effective_discount": 0,325 "amount_paid_roundoff": 130326 },327 "order_created": "2024-04-04T16:46:25+00:00",328 "gst_details": {329 "gstin_code": "24AAICN1205F1Z0",330 "gst_tag": "SGST",331 "hsn_code": "33061020",332 "value_of_good": 110.17,333 "gst_tax_percentage": 18,334 "is_default_hsn_code": false,335 "brand_calculated_amount": 130,336 "tax_collected_at_source": 0,337 "hsn_code_id": "627782f15e4c6fdbc8be30de",338 "gst_fee": 19.83,339 "igst_tax_percentage": 0,340 "sgst_tax_percentage": 9,341 "cgst_tax_percentage": 9,342 "igst_gst_fee": "0",343 "cgst_gst_fee": "9.91",344 "sgst_gst_fee": "9.91",345 "tax_rule_id": "627783925e4c6fdbc8be40c7"346 },347 "line_number": 1,348 "applied_promos": [],349 "taxes": [350 {351 "name": "GST",352 "rate": 0.09,353 "taxable_amount": 231.19,354 "tax_amount": 20.81355 }356 ],357 "meta": {358 "charges": [359 {360 "name": "amount_paid",361 "type": "amount_paid",362 "amount": {363 "value": 130,364 "currency": "INR"365 }366 },367 {368 "name": "price_effective",369 "type": "price_effective",370 "amount": {371 "value": 130,372 "currency": "INR"373 }374 },375 {376 "name": "price_marked",377 "type": "price_marked",378 "amount": {379 "value": 199,380 "currency": "INR"381 }382 },383 {384 "name": "mrp",385 "type": "mrp",386 "amount": {387 "value": 199,388 "currency": "INR"389 }390 },391 {392 "name": "unit_price",393 "type": "unit_price",394 "amount": {395 "value": 130,396 "currency": "INR"397 }398 },399 {400 "name": "delivery_charge",401 "type": "delivery_charge",402 "amount": {403 "value": 0,404 "currency": "INR"405 }406 },407 {408 "name": "discount",409 "type": "discount",410 "amount": {411 "value": 69,412 "currency": "INR"413 }414 }415 ],416 "group_id": "",417 "gift_card": {},418 "docket_number": "171222938453912348961",419 "partial_can_ret": false,420 "parent_docket_number": "171222938453912348961",421 "delivery_charges_hsn_code": "996819",422 "multi_quantity_bag_enabled": false423 }424 }425 ],426 "bag_status_history": [427 {428 "delivery_awb_number": null,429 "bag_id": 33938213,430 "created_at": "2024-04-04T16:46:25+00:00",431 "status": "pending",432 "state_id": 89,433 "updated_ts": "2024-04-04T11:16:24Z",434 "delivery_partner_id": null,435 "shipment_id": "17122293845391234896",436 "id": 217656544,437 "state_type": "operational",438 "updated_at": "2024-04-04T16:46:25+00:00",439 "created_ts": "2024-04-04T11:16:24Z",440 "store_id": 22665,441 "kafka_sync": false,442 "bag_state_mapper": {443 "journey_type": "forward",444 "app_display_name": "Pending",445 "state_type": "operational",446 "app_state_name": "pending",447 "name": "pending",448 "app_facing": true,449 "id": 89,450 "display_name": "Pending",451 "notify_customer": true,452 "is_active": true453 },454 "reasons": [],455 "action_user": {}456 },457 {458 "delivery_awb_number": null,459 "bag_id": 33938213,460 "created_at": "2024-04-04T16:46:25+00:00",461 "status": "placed",462 "state_id": 1,463 "updated_ts": "2024-04-04T11:16:24Z",464 "delivery_partner_id": null,465 "shipment_id": "17122293845391234896",466 "id": 217656545,467 "state_type": "operational",468 "updated_at": "2024-04-04T16:46:25+00:00",469 "created_ts": "2024-04-04T11:16:24Z",470 "store_id": 22665,471 "kafka_sync": false,472 "bag_state_mapper": {473 "journey_type": "forward",474 "app_display_name": "Processing",475 "state_type": "operational",476 "app_state_name": "processing",477 "name": "placed",478 "app_facing": true,479 "id": 1,480 "display_name": "Placed",481 "notify_customer": true,482 "is_active": true483 },484 "reasons": [],485 "action_user": {}486 }487 ],488 "fulfilling_store": {489 "id": 22665,490 "code": "HS-d3483",491 "name": "Natureovedic Consumers Private Limited",492 "address": "dummy data",493 "state": "Gujarat",494 "city": "Ahmedabad",495 "pincode": "380015",496 "country": "India",497 "phone": "1111111111",498 "meta": {499 "timing": [500 {501 "weekday": "monday",502 "opening": {503 "hour": 11,504 "minute": 0505 },506 "closing": {507 "hour": 21,508 "minute": 30509 },510 "open": true511 },512 {513 "weekday": "tuesday",514 "opening": {515 "hour": 11,516 "minute": 0517 },518 "closing": {519 "hour": 21,520 "minute": 30521 },522 "open": true523 },524 {525 "weekday": "wednesday",526 "opening": {527 "hour": 11,528 "minute": 0529 },530 "closing": {531 "hour": 21,532 "minute": 30533 },534 "open": true535 },536 {537 "weekday": "thursday",538 "opening": {539 "hour": 11,540 "minute": 0541 },542 "closing": {543 "hour": 21,544 "minute": 30545 },546 "open": true547 },548 {549 "weekday": "friday",550 "opening": {551 "hour": 11,552 "minute": 0553 },554 "closing": {555 "hour": 21,556 "minute": 30557 },558 "open": true559 },560 {561 "weekday": "saturday",562 "opening": {563 "hour": 11,564 "minute": 0565 },566 "closing": {567 "hour": 21,568 "minute": 30569 },570 "open": true571 },572 {573 "weekday": "sunday",574 "opening": {575 "hour": 11,576 "minute": 0577 },578 "closing": {579 "hour": 21,580 "minute": 30581 },582 "open": true583 }584 ],585 "stage": null,586 "display_name": "Natureovedic Consumers Private Limited",587 "notification_emails": [588 "test@example.com"589 ],590 "product_return_config": {591 "on_same_store": true592 },593 "gst_credentials": {594 "e_invoice": {595 "enabled": false596 },597 "e_waybill": {598 "enabled": false599 }600 },601 "gst_number": "24AAICN1205F1Z0",602 "additional_contact_details": {603 "number": [604 "91 - 8888888888"605 ]606 },607 "documents": {608 "gst": {609 "type": "gst",610 "value": "24AAICN1205F1Z0",611 "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/6367/stores/all/legal/documents/free/original/gR4EJCW-q-Natureovedic-GST-Gujarat.pdf",612 "verified": true,613 "legal_name": "NATUREOVEDIC CONSUMERS PRIVATE LIMITED"614 }615 },616 "auto_invoice": false,617 "credit_note": false,618 "ewaybill_portal_details": null619 },620 "fulfillment_channel": "pulse",621 "location_type": "high_street",622 "company_id": 6367,623 "is_active": false,624 "tags": []625 },626 "prices": {627 "amount_paid": 130,628 "refund_amount": 130,629 "price_marked": 199,630 "cod_charges": 0,631 "discount": 69,632 "cashback_applied": 0,633 "delivery_charge": 0,634 "fynd_credits": 0,635 "cashback": 0,636 "price_effective": 130,637 "refund_credit": 0,638 "value_of_good": 110.17,639 "coupon_value": 0,640 "tax_collected_at_source": 0,641 "promotion_effective_discount": 0,642 "fynd_promotion_effective_discount": 0,643 "seller_promotion_effective_discount": 0,644 "cn_refund_amount": 0,645 "gift_price": 0,646 "amount_paid_roundoff": 130647 },648 "payments": {649 "id": 2,650 "mode": "COD",651 "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payment/default_card.png",652 "display_name": "COD",653 "display_priority": 1,654 "source": "Cash on Delivery",655 "is_active": true656 },657 "affiliate_details": {658 "id": "63f893a94adb0bbd79de0344",659 "affiliate_bag_id": "17122293829511256932J-1",660 "affiliate_order_id": "17122293670136786A",661 "company_affiliate_tag": "JIOMART",662 "affiliate_id": "63f893a94adb0bbd79de0344",663 "affiliate_shipment_id": "17122293829511256932J",664 "shipment_meta": {665 "sla": null,666 "weight": 500,667 "due_date": "2024-04-05T00:46:23.000Z",668 "external": {},669 "vertical": "NA",670 "lock_data": {671 "mto": false,672 "locked": false,673 "lock_message": ""674 },675 "bag_weight": {676 "33938213": 500677 },678 "debug_info": {679 "stormbreaker_uuid": ""680 },681 "dp_options": {},682 "order_type": "HomeDelivery",683 "dp_sort_key": null,684 "is_self_ship": false,685 "delivery_slots": {},686 "courier_partners": [],687 "fulfillment_tags": [],688 "is_international": false,689 "processing_dates": {690 "due_date": "2024-04-05T00:46:23.000Z",691 "dispatch_by_date": "2024-04-05T00:46:23.000Z"692 },693 "is_export_shipment": false,694 "same_store_available": true,695 "fulfilment_priority_text": null,696 "auto_trigger_dp_assignment_ACF": true,697 "eligible_for_split": false698 },699 "affiliate_meta": {700 "fynd": {701 "fulfilment_identifier": "pulse",702 "fulfilment_identifiers_list": [703 "pulse"704 ]705 },706 "channel_shipment_id": null,707 "channel_order_id": null,708 "due_date": null,709 "is_priority": false,710 "box_type": null,711 "coupon_code": null,712 "size_level_total_qty": null,713 "loyalty_discount": 0,714 "employee_discount": 0715 },716 "affiliate_store_id": "3PPBWQTUJFC03",717 "pdf_links": {718 "label_type": "external",719 "invoice_type": "external"720 },721 "config": {722 "id": "63f893a94adb0bbd79de0344",723 "meta": [724 {725 "name": "shipment_lock_states",726 "value": [727 "bag_confirmed",728 "dp_assigned"729 ]730 }731 ],732 "name": "JIOMART",733 "token": null,734 "dp_assignment": false,735 "app_company_id": 6367,736 "article_assignment": {},737 "force_reassignment": false,738 "sales_channel_logo": "",739 "ordering_channel_logo": "",740 "post_order_reassignment": false741 }742 },743 "article_details": {744 "status": {745 "placed": {746 "659fe876fc7c748f7333b086": {747 "uid": "659fe876fc7c748f7333b086",748 "_id": "659fe876fc7c748f7333b086",749 "is_set": "",750 "bag_ids": [751 {752 "bag_id": 33938213,753 "quantity": 1754 }755 ],756 "quantity": 1,757 "reasons": {}758 }759 }760 }761 },762 "dp_details": {763 "id": null,764 "name": null,765 "awb_no": null,766 "eway_bill_id": null,767 "track_url": null,768 "gst_tag": "sgst",769 "extension_id": null,770 "scheme_id": null,771 "courier_partner_slug": null772 },773 "rto_address": {774 "location_type": "high_street",775 "name": "Natureovedic Consumers Private Limited",776 "store_address_json": {777 "version": "1.0",778 "contact_person": "test user",779 "address": "",780 "address1": "dummy data",781 "address2": "",782 "name": "test user",783 "area": "",784 "area_code": "",785 "area_code_slug": "",786 "landmark": "",787 "city": "Ahmedabad",788 "state": "Gujarat",789 "country": "India",790 "pincode": "380015",791 "longitude": 71.5723953,792 "sector": "",793 "latitude": 22.6708317,794 "phone": "1111111111",795 "email": "test@example.com",796 "address_type": "store",797 "address_category": "store",798 "created_at": "2024-04-04 16:46:24",799 "updated_at": "2024-04-04 16:46:24",800 "country_phone_code": null,801 "country_iso_code": "IN",802 "country_code": "IN",803 "display_address": "dummy data"804 },805 "id": 22665,806 "code": "HS-d3483",807 "company_id": 6367,808 "address1": "dummy data",809 "address2": "",810 "display_address": "dummy data",811 "city": "Ahmedabad",812 "state": "Gujarat",813 "sector": "",814 "country": "India",815 "pincode": "380015",816 "store_email": "test@example.com",817 "contact_person": "test user",818 "phone": "1111111111"819 },820 "weight": {821 "value": 500,822 "unit": "gram"823 },824 "shipment_meta": {825 "sla": null,826 "weight": 500,827 "due_date": "2024-04-05T00:46:23.000Z",828 "external": {},829 "vertical": "NA",830 "lock_data": {831 "mto": false,832 "locked": false,833 "lock_message": ""834 },835 "bag_weight": {836 "33938213": 500837 },838 "debug_info": {839 "stormbreaker_uuid": ""840 },841 "dp_options": {},842 "order_type": "HomeDelivery",843 "dp_sort_key": null,844 "is_self_ship": false,845 "delivery_slots": {},846 "courier_partners": [],847 "fulfillment_tags": [],848 "is_international": false,849 "processing_dates": {850 "due_date": "2024-04-05T00:46:23.000Z",851 "dispatch_by_date": "2024-04-05T00:46:23.000Z"852 },853 "is_export_shipment": false,854 "same_store_available": true,855 "fulfilment_priority_text": null,856 "auto_trigger_dp_assignment_ACF": true,857 "eligible_for_split": false858 },859 "shipment_gst": {860 "value_of_good": 110.17,861 "gst_fee": 19.83,862 "brand_calculated_amount": 130,863 "tax_collected_at_source": 0,864 "gstin_code": "24AAICN1205F1Z0"865 },866 "store_invoice_id": null,867 "credit_note_id": "",868 "order_created": "2024-04-04T16:46:25+00:00",869 "payment_methods": {870 "COD": {871 "amount": 130,872 "mode": "COD",873 "name": "COD",874 "collect_by": "seller",875 "refund_by": "seller",876 "meta": {877 "payment_id": null878 }879 }880 },881 "payment_info": [],882 "order": {883 "ordering_channel": "MARKETPLACE",884 "ordering_source": "marketplace",885 "affiliate_order_date": "2024-04-04T16:46:25+00:00",886 "affiliate_order_id": "17122293670136786A",887 "fynd_order_id": "FYMP660E8C0801AD7F2D",888 "mode_of_payment": "FY_JIOMART",889 "source": "NA",890 "total_order_value": 0,891 "collect_by": "seller",892 "refund_by": "seller",893 "order_value": 0,894 "meta": {895 "staff": {},896 "charges": [897 {898 "code": "",899 "name": "COD Charges",900 "type": "cod_charges",901 "amount": {902 "value": 0,903 "currency": "INR"904 }905 },906 {907 "code": "",908 "name": "Delivery Charges",909 "type": "delivery_charges",910 "amount": {911 "value": 0,912 "currency": "INR"913 }914 }915 ],916 "currency": {917 "currency_code": "INR",918 "currency_name": "Indian Rupee",919 "currency_symbol": "₹",920 "currency_sub_unit": "Paisa"921 },922 "extra_meta": {},923 "order_type": "new",924 "employee_id": "",925 "company_logo": null,926 "payment_type": null,927 "currency_info": {},928 "mongo_cart_id": 1000000007,929 "ordering_store": null,930 "seller_details": {},931 "conversion_rate": {932 "base": "INR",933 "rates": {934 "INR": {935 "name": "Indian Rupee",936 "value": 1,937 "symbol": "₹",938 "sub_unit": "Paisa"939 }940 },941 "timestamp": 1712057944.367167942 },943 "sales_channel_logo": "",944 "order_child_entities": [945 "bag",946 "shipment"947 ],948 "billing_staff_details": {},949 "ordering_channel_logo": "",950 "platform_user_details": {},951 "external_creation_date": "1712249183",952 "order_tags": []953 }954 },955 "order_source": "NA",956 "journey_type": "forward",957 "einvoice_info": {},958 "lock_status": false,959 "original_bag_list": [960 33938213961 ],962 "shipment_update_time": 1712229384.71709,963 "transaction_meta": {},964 "meta": {965 "sla": null,966 "weight": 500,967 "due_date": "2024-04-05T00:46:23.000Z",968 "external": {},969 "vertical": "NA",970 "lock_data": {971 "mto": false,972 "locked": false,973 "lock_message": ""974 },975 "bag_weight": {976 "33938213": 500977 },978 "debug_info": {979 "stormbreaker_uuid": ""980 },981 "dp_options": {},982 "order_type": "HomeDelivery",983 "dp_sort_key": null,984 "is_self_ship": false,985 "delivery_slots": {},986 "courier_partners": [],987 "fulfillment_tags": [],988 "is_international": false,989 "processing_dates": {990 "due_date": "2024-04-05T00:46:23.000Z",991 "dispatch_by_date": "2024-04-05T00:46:23.000Z"992 },993 "is_export_shipment": false,994 "same_store_available": true,995 "fulfilment_priority_text": null,996 "auto_trigger_dp_assignment_ACF": true,997 "eligible_for_split": false998 },999 "previous_shipment_id": null,1000 "fyndstore_emp": {},1001 "ordering_store": {},1002 "coupon": {},1003 "cart_info": {1004 "cart_id": "",1005 "cart_uid": 10000000071006 }1007 }1008 }1009}
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
shipment
object
Required
Properties
status
string
Required
Webhook shipment status, i.e., either create or update
shipment_status
object
Required
Status of the shipment indicating its current stage
Properties
created_at
string
Required
Shipment status created timestamp
created_ts
string
Required
Shipment status created timestamp
id
number
Required
Unique identifier associated with the shipment's status object
updated_ts
string
Required
Shipment status updated timestamp
bag_list
array of string
Required
List of Bag ids transitioned in this shipment's status
shipment_id
string
Required
Unique shipment no. that is auto-generated
status
string
Required
Shipment's operational status
current_shipment_status
string
Required
Current shipment's status; it can be financial, logistics or operational
status_created_at
string
Required
application_id
string
Required
ID of the sales channel to which the shipment belongs
shipment_id
string
Required
Unique shipment no. that is auto-generated
company_id
number
Required
ID of the company fulfilling the shipment
app_company_id
number|null|string
Required
ID of the company from which order was placed
order_id
string
Required
Unique ID of order in which the shipment is present
merchant_id
string
Required
Unique merchant id
user
object
Required
Purchaser's details such as name, last name, mobile no. and email
Properties
email
string|null
Email address of the purchaser user
id
number|null
Unique identifier for the purchaser user within the system
gender
null|string
Gender of the purchaser user (e.g., male, female, other)
first_name
string
First name of the purchaser user
external_customer_id
string|null
External identifier associated with the purchaser user in another system
mobile
string|null
Mobile phone number of the purchaser user
last_name
string
Last name of the purchaser user
mongo_user_id
string|null
User's object ID in mongodb collection
user_oid
string|null
User Object ID assigned within the system
country_phone_code
string|null
Country phone code associated with the purchaser user's mobile number
is_anonymous_user
boolean
Flag indicating whether the user is anonymous
delivery_address
object
Required
Address where the shipment is to be delivered
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the recipient's name or the organization name associated with the address
email
string
Email of the recipient associated with the delivery address
phone
string
Mobile phone number of recipient associated with the delivery address
state
string
A string indicating the state or province of the delivery address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
user_id
number|null
Unique identifier for the fulfilling user within the system
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the recipient associated with the delivery address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the delivery address was created
first_name
string
First name of the recipient associated with the delivery address
updated_at
string
| date-time
Date and time when the delivery address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the delivery address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the delivery address
display_address
string
Formatted display version of the delivery address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
billing_address
object
Required
Address by which the invoice is created
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the billing user's name or the organization name associated with the address
email
string
Email address associated with the billing address user
phone
string
Phone number associated with the billing address user
state
string
A string indicating the state or province of the billing address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the individual associated with the billing address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the billing address was created
first_name
string
First name of the individual associated with the billing address
updated_at
string
| date-time
Date and time when the billing address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the billing address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the billing address
display_address
string
Formatted display version of the billing address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
delivery_partner_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
bags
array of object
Required
Details of all the products/articles in a shipment
Array of Properties
financial_breakup
array of object
Required
Financial breakup of an item
Array of Properties
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
discount
number
Required
The total amount discounted from the original MRP/actual price
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
identifiers
object
Required
Product identifiers
Properties
sku_code
string
SKU code of the product
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
total_units
number
Required
Total number of units of the item
value_of_good
number
Required
Effective selling price - Product GST Amount
item_name
string
Required
The name of the item being referenced
size
string
Required
The physical dimensions or specifications of the item, indicating its size or measurements
loyalty_discount
number
Amount reduced from the payable price when the customer applies loyalty program points while placing the order
entity_type
string
Required
item
object
Required
Item details
Properties
l3_category_name
string
The name of the level 3 category to which the item belongs
l1_category_id
number
ID representing the level 2 category classification of the item
code
string
A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes
branch_url
null|string
Branch URL
l2_category
array of string
l3_category
number
ID representing the level 3 category classification of the item
last_updated_at
string
| date-time
Timestamp when the item was last updated
id
number
ID of the item that is being referred
name
string
The name of the item being referenced
can_return
boolean
Flag indicating if the item is eligible for return
webstore_product_url
null|string
Product URL
gender
null|string
Gender associated with an item
l2_category_id
number
ID representing the level 2 category classification of the item
color
null|string
Color associated with and item
slug_key
string
Automatically generated unique slug of the item
can_cancel
boolean
Flag indicating if the item is eligible for cancellation
attributes
object
An object containing descriptive properties of the item
Properties
name
string
The name or title of the item
color
string
The color description of the item
essential
string
Indicates whether the item is considered essential
brand_name
string
The brand name of the item
primary_color
string
The primary color of the item
primary_color_hex
string
The hexadecimal code representing the primary color
primary-colour-hex-code
string
The hexadecimal code representing the primary color
media
array of object
An array containing media files associated with the item
brand_id
number
The unique identifier associated with the brand of the item
brand
string
The brand or manufacturer of the item
l1_category
array of string
department_id
number
The unique identifier representing the department or category to which the item belongs
size
string
The size or dimensions of the item
image
array of string
brand
object
Required
Brand's information
Properties
credit_note_allowed
boolean
Required
If a credit note ID needs to be generated by the system
created_on
string
Required
Date and time when the brand was registered or created
id
number
Required
Unique identifier assigned to the brand for reference and identification
logo
string
Required
Visual representation or emblem associated with the brand
modified_on
string
Required
Date and time of the most recent update or modification to the brand's information
is_virtual_invoice
boolean
Required
If invoice ID needs to be generated by the system
brand_name
string
Required
Name or title of the brand used for identification and representation
bag_id
number
Required
article
object
Required
Details of the article
Properties
identifiers
object
Required
Product identifiers
Properties
sku_code
string
esp_modified
string|boolean
Required
Flag representing if effective selling price has been modified
size
string
Required
The physical dimensions or specifications of the article, indicating its size or measurements
code
string
Required
A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes
set
object
Required
Details of the set article containing size distribution
Properties
quantity
integer
Number of units present
size_distribution
object
Object indicating the distribution of size and quantity of a set article
Properties
sizes
array of object
Array indicating size wise units present in a set article
Array of Properties
pieces
integer
Number of units of a particular size
size
string
Size of the article
is_set
string|boolean
Required
A boolean indicating whether the article is a set
seller_identifier
string
Required
Seller's identifier of the article
return_config
object
Required
Return configuration details of the article
Properties
time
number
Required
Number indicating number of hours or days
unit
string
Required
String indicating the unit of the time, eg. days, hours
returnable
boolean
Required
Flag indicating whether product is returnable or not
_id
string
Required
DB generated ID of the article
uid
string
Required
UID of the article
child_details
object|array
Required
Child article details if any
bundle_details
object
Contains bundle-related metadata for the shipment.
Properties
bundle_group_id
string
Unique group identifier for the bundle.
name
string
Name of the bundle.
slug
string
URL-friendly identifier for the bundle.
price_marked
number
Maximum Retail Price of the bundle.
price_effective
number
Current selling price of the bundle.
item_id
integer
Unique identifier for the item.
item_type
string
Type of the item (physical_bundle, virtual_bundle).
Enum
return_config
object
Refund Config for bundle product
Properties
allow_partial_return
boolean
Nullable
The line number of the parent bag.
returnable
boolean
Nullable
The line number of the parent bag.
unit
boolean
Nullable
The line number of the parent bag.
time
boolean
Nullable
The line number of the parent bag.
seller_identifier
string
Identifier for the seller of the bundle.
images
array of string
An array of image URLs associated with the bundle.
bundle_article_quantity
integer
Article net_quantity in bundle Product.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
dimensions
object
Required
The dimension object of the article/item
Properties
height
number|null
The height of the product
width
number|null
The width of the product
is_default
boolean|null
Whether the dimension is the default one or not
unit
string|null
The unit of dimension
length
number|null
The length of the product
weight
object
Required
Object containing weight details of item/article
Properties
unit
string
The unit of weight
shipping
number
The shipping weight of the product
is_default
boolean
Whether the weight is the default one or not
currency
object
Required
Order currency details
Properties
code
string
Currency code
rate
number
The conversion rate value
expiration_date
Undefined Type
Required
current_operational_status
object
Required
Properties
created_at
string
| date-time
Required
Date and time when the shipment status record was created
created_ts
string
Required
Timestamp indicating the exact time when the shipment status record was created
id
number
Required
Unique identifier for the shipment status record
kafka_sync
boolean
Required
Flag indicating whether the shipment status update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the shipment status record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the shipment status record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
ID of the fulfilling store of the shipment
status
string
Required
Current operational status of the shipment
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Details of the user who initiated the change in the shipment's status
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
affiliate_bag_details
object
Required
Object containing external bag details like external order id, external bag id
Properties
affiliate_bag_id
string
Required
External bag id
affiliate_order_id
string
Required
External order id
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
quantity
number
Required
Total quantity of the article present in the bag.
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
price_effective
number
Required
MRP - Initial Seller provided discount
discount
number
Required
The total amount discounted from the original MRP/actual price
amount_paid
number
Required
Amount paid by the customer
coupon_effective_discount
number
Required
Coupon provided by brand or seller
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cod_charges
number
Required
The fee associated with the COD order
refund_credit
number
Required
Refund credits provided to the customer
cashback
number
Required
Cashback points
refund_amount
number
Required
Amount to be refunded on cancellation and return
added_to_fynd_cash
boolean
Required
Flag indicating whether fynd cash has been used
cashback_applied
number
Required
Cashback applied on the order
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
value_of_good
number
Required
Effective selling price - Product GST Amount
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
transfer_price
number
Required
article
brand_calculated_amount
number
Required
Price Effective - Coupon Discount (Seller) - Promotion (Seller)
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
gift_price
number
Required
Gift card amount used
coupon_value
number
Required
Stores the coupon value as shown in the cart
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
amount_paid_roundoff
number
Required
Amount paid rounded off
loyalty_discount
number
Amount reduced from the payable price when the customer applies loyalty program points while placing the order
order_created
string
Required
Order creation timestamp
gst_details
object
Required
GST details associated with the bag
Properties
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
is_default_hsn_code
boolean
Required
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
hsn_code_id
string|null
Required
The unique identifier associated with HSN code
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
igst_tax_percentage
number
Required
Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions
sgst_tax_percentage
number
Required
Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state
cgst_tax_percentage
number
Required
Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state
igst_gst_fee
string|number
Required
Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions
cgst_gst_fee
string
Required
Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state
sgst_gst_fee
string
Required
Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state
tax_rule_id
string
ID of the tax rule associated with the product
line_number
number
Required
Unique identifier associated with each bag in a shipment
applied_promos
array of object
Required
Details of the applied promotions
Array of Properties
promo_id
string
Promotion id
buy_rules
array of object
Buy rules for promotions
Array of Properties
item_criteria
object
Item criteria of promotion
cart_conditions
object
Cart conditions details for promotion
offer_text
string
Offer text of current promotion
promotion_group
string
Promotion group for the promotion
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_name
string
Promotion name of current promotion
amount
number
Per unit discount amount applied with current promotion
discount_rules
array of object
Discount rules for promotions
Array of Properties
matched_buy_rules
array of string
Matched buy rules for promotion
raw_offer
object
raw offer details for promotion
offer
object
offer for promotion
item_criteria
object
Item criteria of promotion
ownership
object
Ownership of promotion
Properties
payable_category
string
promo amount payable category
payable_by
string
promo amount bearable party
article_quantity
integer
Quantity of article on which promotion is applicable
applied_free_articles
array of object
Applied free article for free gift item promotions
Array of Properties
free_gift_item_details
object
Free gift items details
Properties
item_slug
string
item slug
item_name
string
Item name
item_price_details
object
item price details
item_brand_name
string
item brand name
item_id
integer
Item id
item_images_url
array of string
item images URL
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
Free article quantity
article_id
string
free article id
promotion_type
string
Promotion type of current promotion
meta
object
Meta object for extra data
code
string|null
Promotion code
taxes
array of object
Required
Details of taxes applied on products
Array of Properties
name
string
Name of the tax applied (e.g., GST, CGST, SGST, VAT)
rate
number
Tax rate applied, represented as a decimal value (e.g., 0.09 for 9%)
taxable_amount
number
Amount on which the tax is calculated, after applicable discounts or exemptions
tax_amount
number
Final tax amount calculated using the tax rate on the taxable amount
bag_status_history
array of object
Required
Records the changes in status for a bag, providing a timeline of events and transitions
Array of Properties
created_at
string
| date-time
Required
Date and time when the bag status history record was created.
created_ts
string
Required
Timestamp indicating the exact time when the bag status history record was created
id
number
Required
Unique identifier for the bag status history record
kafka_sync
boolean
Required
Flag indicating whether the bag status history update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the bag status history record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the bag status history record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
Store id associated with the bag
status
string
Required
Webhook shipment status, i.e., either create or update
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
fulfilling_store
object
Required
Details of the store responsible for fulfilling the order
Properties
id
number
Required
Unique identifier for the store.
code
string
Required
Alphanumeric code representing the store.
name
string
Required
Name of the store.
address
string
Required
Physical address of the store.
state
string
Required
State where the store is located.
city
string
Required
City where the store is located.
pincode
string
Required
Postal code (pincode) of the store's location.
country
string
Required
Country where the store is situated.
phone
string
Required
Contact phone number for the store.
fulfillment_channel
string
Required
Type of fulfillment channel used by the store.
location_type
string
Required
Type of location e.g., warehouse, high_street
Enum
company_id
number
Required
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Required
Boolean indicating whether the store is currently active
tags
array of string
Required
Array of tags associated with the store
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
amount_paid
number
Required
Amount paid by the customer
refund_amount
number
Required
Amount to be refunded on cancellation and return
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
cod_charges
number
Required
The fee associated with the COD order
discount
number
Required
The total amount discounted from the original MRP/actual price
cashback_applied
number
Required
Cashback applied on the order
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cashback
number
Required
Cashback points
price_effective
number
Required
MRP - Initial Seller provided discount
refund_credit
number
Required
Refund credits provided to the customer
value_of_good
number
Required
Effective selling price - Product GST Amount
coupon_value
number
Required
Stores the coupon value as shown in the cart
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
cn_refund_amount
number
Required
Amount to be refunded through credit note
gift_price
number
Required
Gift card amount used
amount_paid_roundoff
number
Amount paid rounded off
loyalty_discount
number
Amount reduced from the payable price when the customer applies loyalty program points while placing the order
payments
object
Required
Object containing payment mode and payment breakup
Properties
id
number
Required
Unique identifier for the payment mode
mode
string
Required
Type or category of the payment mode (e.g., PP, COD)
logo
string
Required
URL or path to the logo/icon representing the payment mode
display_name
string
Required
Name or label used to display the payment mode
display_priority
number
Required
Priority order for displaying the payment mode
source
string
Required
Merchant of the payment mode (e.g., PartnerPay, JioPp)
is_active
boolean
Required
Boolean indicating whether the payment mode is currently active
affiliate_details
object
Required
Application related details like config, order_id, shipment id
Properties
id
string|number
Required
Identifier for the application, can be application_id or extension_id
affiliate_bag_id
string
Required
Identifier assigned by the application for the bag
affiliate_order_id
string
Required
Identifier of the order assigned by the application
company_affiliate_tag
string
Required
Tag associated with the bag from the application's company
affiliate_id
string
Required
Identifier for the application, can be application_id or extension_id
affiliate_shipment_id
string
Required
Identifier of the shipment assigned by the application
affiliate_store_id
string
Required
Identifier of the store assigned by the application
pdf_links
object
Required
PDF Links pushed by the application or extension
Properties
label_type
string
Required
Label type - external
invoice_type
string
Required
Invoice type - external
label
string
Label URL provided by the application or extension
invoice
string
Invoice URL provided by the application or extension
config
object
Required
Application configuration details
Properties
id
string|number
Identifier for the application, can be application_id or extension_id
name
string
Application name
token
null|string
Application token - deprecated
dp_assignment
boolean
Flag indicating whether auto DP assignment should happen from system
app_company_id
number|null|string
ID of the company from which order was placed
article_assignment
object
The article assignment settings
Properties
strategy
string
Enum
level
string
Enum
force_reassignment
boolean
Indicates whether force reassignment is enabled
sales_channel_logo
string
Logo URL of the application to which order belongs
ordering_channel_logo
string
Logo URL of the ordering channel
post_order_reassignment
boolean
Indicates whether post-order reassignment is enabled
dp_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
rto_address
object
Required
The address to which shipment should be delivered in case of RTO
Properties
company_id
number
Required
ID of the company fulfilling the shipment
id
number
Required
ID of the store where RTO should happen
name
string
Required
A string representing the store's name
store_address_json
object
Required
Store address details
Properties
version
string
Address version, to be deprecated
contact_person
string
Name of the contact person associated with the address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
name
string
A string representing the store's name
area
string
A string specifying the locality or area associated with the address
area_code
string
Area code of the address
area_code_slug
string
Unique identifier or slug for the area code associated with the address
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
city
string
A string denoting the city or municipality of the address
state
string
A string indicating the state or province of the address
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
longitude
number|string
The longitude of the address
sector
string
A string specifying the sector or district of the address if applicable
latitude
number|string
The latitude of the address
phone
string
Mobile phone number of recipient associated with the address
email
string
Email of the recipient associated with the address
address_type
string
Type of address (e.g., home, office, registered)
address_category
string
Category or classification of the address
created_at
string
| date-time
Date and time when the address was created
updated_at
string
| date-time
Date and time when the address was last updated
country_phone_code
string|null
Phone code for the country of the address
country_iso_code
string
ISO code representing the country of the address
country_code
string
ISO code representing the country of the address
display_address
string
Formatted display version of the address
code
string
Required
Alphanumeric code representing the store
location_type
string
Required
Type of location e.g., warehouse, high_street
address1
string
Required
"A string representing the first line of the address, typically containing street or building information"
address2
string
Required
"A string representing the second line of the address, which can be used for additional address details if needed"
display_address
string
Required
Formatted display version of the address
city
string
Required
A string denoting the city or municipality of the address
state
string
Required
A string indicating the state or province of the address
sector
string
Required
A string specifying the sector or district of the address if applicable
country
string
Required
A string indicating the country of the address
pincode
string
Required
A string indicating the postal code or PIN code of the address area
store_email
string
Required
Email of the recipient associated with the store
contact_person
string
Required
Name of the contact person associated with the address
phone
string
Required
Mobile phone number of recipient associated with the address
weight
object
Required
Weight details for item/article
Properties
value
number
Required
unit
string
Required
shipment_gst
object
Required
GST details associated with the shipment
Properties
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
store_invoice_id
string|null
Required
Invoice ID attached to the shipment
credit_note_id
string|null
Required
Credit Note ID attached to the shipment
order_created
string
Required
Order creation timestamp
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
payment_info
array of Undefined Type
Required
"Array of object containing payment methods used for placing an order."
order
object
Required
Order level details
Properties
ordering_channel
string
Required
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Nullable
To uniquely identify the source through which order has been placed.
affiliate_order_date
string|null
| date-time
Required
Order creation timestamp at application/extension end
affiliate_order_id
string
Required
Identifier of the order assigned by the application
fynd_order_id
string
Required
System generated unique identifier of the order
mode_of_payment
string
Required
Unique identifier associated with the payment mode
source
string
Required
Ordering source eg. affiliate, fynd
total_order_value
number
Required
Total order value
collect_by
string
Required
Whomsoever collected the money
refund_by
string
Required
Whomsoever will refund the money
order_value
number
Required
Value of the order
loyalty_discount_details
object
Applied loyalty discount information
Properties
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order
order_source
string
Required
Ordering source eg. affiliate, fynd
journey_type
string|null
Required
Journey type forward or return
einvoice_info
object
Required
Einvoice info if e-invoice is applicable
Properties
credit_note
object
Details of the reverse credit note einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
invoice
object
Details of the forward invoice einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
lock_status
boolean
Required
Lock status of the shipment
original_bag_list
array of number
Required
List of Bag ids when the order was created
shipment_update_time
number
Required
Last shipment update time
previous_shipment_id
string|null
Required
"ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition"
fyndstore_emp
object
Required
Fynd store employee details
ordering_store
object
Required
Store details from which order was placed in case of StoreOS
Properties
id
number
Unique identifier for the store.
code
string
Alphanumeric code representing the store.
name
string
Name of the store.
address
string
Physical address of the store.
state
string
State where the store is located.
city
string
City where the store is located.
pincode
string
Postal code (pincode) of the store's location.
country
string
Country where the store is situated.
phone
string
Contact phone number for the store.
fulfillment_channel
string
Type of fulfillment channel used by the store.
location_type
string
Type of location e.g., warehouse, high_street
Enum
company_id
number
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Boolean indicating whether the store is currently active
tags
array of string
Array of tags associated with the store
coupon
object
Required
Coupon related details
cart_info
object
Required
Cart related information
Properties
cart_id
string
Required
The unique identifier of the cart
cart_uid
number
Required
UID associated with the cart
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "properties": {77 "shipment": {78 "type": "object",79 "properties": {80 "status": {81 "type": "string",82 "description": "Webhook shipment status, i.e., either create or update"83 },84 "shipment_status": {85 "type": "object",86 "description": "Status of the shipment indicating its current stage",87 "properties": {88 "created_at": {89 "type": "string",90 "description": "Shipment status created timestamp"91 },92 "created_ts": {93 "type": "string",94 "description": "Shipment status created timestamp"95 },96 "id": {97 "type": "number",98 "description": "Unique identifier associated with the shipment's status object"99 },100 "updated_ts": {101 "type": "string",102 "description": "Shipment status updated timestamp"103 },104 "bag_list": {105 "type": "array",106 "description": "List of Bag ids transitioned in this shipment's status",107 "items": {108 "type": "string"109 }110 },111 "shipment_id": {112 "type": "string",113 "description": "Unique shipment no. that is auto-generated"114 },115 "status": {116 "type": "string",117 "description": "Shipment's operational status"118 },119 "current_shipment_status": {120 "type": "string",121 "description": "Current shipment's status; it can be financial, logistics or operational"122 },123 "status_created_at": {124 "type": "string"125 }126 },127 "required": [128 "created_at",129 "created_ts",130 "id",131 "updated_ts",132 "bag_list",133 "shipment_id",134 "status",135 "current_shipment_status",136 "status_created_at"137 ]138 },139 "application_id": {140 "type": "string",141 "description": "ID of the sales channel to which the shipment belongs"142 },143 "shipment_id": {144 "type": "string",145 "description": "Unique shipment no. that is auto-generated"146 },147 "company_id": {148 "type": "number",149 "description": "ID of the company fulfilling the shipment"150 },151 "app_company_id": {152 "type": [153 "number",154 "null",155 "string"156 ],157 "description": "ID of the company from which order was placed"158 },159 "order_id": {160 "type": "string",161 "description": "Unique ID of order in which the shipment is present"162 },163 "merchant_id": {164 "type": "string",165 "description": "Unique merchant id"166 },167 "user": {168 "type": "object",169 "description": "Purchaser's details such as name, last name, mobile no. and email",170 "properties": {171 "email": {172 "type": [173 "string",174 "null"175 ],176 "description": "Email address of the purchaser user"177 },178 "id": {179 "type": [180 "number",181 "null"182 ],183 "description": "Unique identifier for the purchaser user within the system"184 },185 "gender": {186 "type": [187 "null",188 "string"189 ],190 "description": "Gender of the purchaser user (e.g., male, female, other)"191 },192 "first_name": {193 "type": "string",194 "description": "First name of the purchaser user"195 },196 "external_customer_id": {197 "type": [198 "string",199 "null"200 ],201 "description": "External identifier associated with the purchaser user in another system"202 },203 "mobile": {204 "type": [205 "string",206 "null"207 ],208 "description": "Mobile phone number of the purchaser user"209 },210 "last_name": {211 "type": "string",212 "description": "Last name of the purchaser user"213 },214 "mongo_user_id": {215 "type": [216 "string",217 "null"218 ],219 "description": "User's object ID in mongodb collection"220 },221 "user_oid": {222 "type": [223 "string",224 "null"225 ],226 "description": "User Object ID assigned within the system"227 },228 "country_phone_code": {229 "type": [230 "string",231 "null"232 ],233 "description": "Country phone code associated with the purchaser user's mobile number"234 },235 "is_anonymous_user": {236 "type": "boolean",237 "description": "Flag indicating whether the user is anonymous"238 }239 }240 },241 "delivery_address": {242 "type": "object",243 "description": "Address where the shipment is to be delivered",244 "properties": {245 "area": {246 "type": "string",247 "description": "A string specifying the locality or area associated with the address"248 },249 "city": {250 "type": "string",251 "description": "A string denoting the city or municipality of the address"252 },253 "name": {254 "type": "string",255 "description": "A string representing the recipient's name or the organization name associated with the address"256 },257 "email": {258 "type": "string",259 "description": "Email of the recipient associated with the delivery address"260 },261 "phone": {262 "type": "string",263 "description": "Mobile phone number of recipient associated with the delivery address"264 },265 "state": {266 "type": "string",267 "description": "A string indicating the state or province of the delivery address"268 },269 "address": {270 "type": "string",271 "description": "\"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""272 },273 "country": {274 "type": "string",275 "description": "A string indicating the country of the address"276 },277 "pincode": {278 "type": "string",279 "description": "A string indicating the postal code or PIN code of the address area"280 },281 "user_id": {282 "type": [283 "number",284 "null"285 ],286 "description": "Unique identifier for the fulfilling user within the system"287 },288 "version": {289 "type": "string",290 "description": "Address version, to be deprecated"291 },292 "address1": {293 "type": "string",294 "description": "\"A string representing the first line of the address, typically containing street or building information\""295 },296 "address2": {297 "type": "string",298 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""299 },300 "landmark": {301 "type": "string",302 "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""303 },304 "latitude": {305 "type": [306 "number",307 "string"308 ],309 "description": "The latitude of the address"310 },311 "area_code": {312 "type": "string",313 "x-not-enum": true,314 "description": "Area code of the address"315 },316 "last_name": {317 "type": "string",318 "description": "Last name of the recipient associated with the delivery address"319 },320 "longitude": {321 "type": [322 "number",323 "string"324 ],325 "description": "The longitude of the address"326 },327 "created_at": {328 "type": "string",329 "format": "date-time",330 "description": "Date and time when the delivery address was created"331 },332 "first_name": {333 "type": "string",334 "description": "First name of the recipient associated with the delivery address"335 },336 "updated_at": {337 "type": "string",338 "format": "date-time",339 "description": "Date and time when the delivery address was last updated"340 },341 "address_type": {342 "type": "string",343 "x-not-enum": true,344 "description": "Type of address (e.g., home, office, registered)"345 },346 "geo_location": {347 "required": [],348 "description": "Geographic coordinates (latitude and longitude) of the delivery address",349 "type": "object",350 "properties": {351 "latitude": {352 "type": [353 "number",354 "string"355 ],356 "description": "The latitude of the geolocation"357 },358 "longitude": {359 "type": [360 "number",361 "string"362 ],363 "description": "The longitude of the geolocation"364 }365 }366 },367 "area_code_slug": {368 "type": "string",369 "description": "Unique identifier or slug for the area code associated with the address"370 },371 "contact_person": {372 "type": "string",373 "description": "Name of the contact person associated with the delivery address"374 },375 "display_address": {376 "type": "string",377 "description": "Formatted display version of the delivery address"378 },379 "address_category": {380 "type": "string",381 "x-not-enum": true,382 "description": "Category or classification of the delivery address"383 },384 "country_iso_code": {385 "type": "string",386 "x-not-enum": true,387 "description": "ISO code representing the country of the delivery address"388 },389 "country_phone_code": {390 "type": [391 "string",392 "null"393 ],394 "x-not-enum": true,395 "description": "Phone code for the country of the delivery address"396 }397 }398 },399 "billing_address": {400 "type": "object",401 "description": "Address by which the invoice is created",402 "properties": {403 "area": {404 "type": "string",405 "description": "A string specifying the locality or area associated with the address"406 },407 "city": {408 "type": "string",409 "description": "A string denoting the city or municipality of the address"410 },411 "name": {412 "type": "string",413 "description": "A string representing the billing user's name or the organization name associated with the address"414 },415 "email": {416 "type": "string",417 "description": "Email address associated with the billing address user"418 },419 "phone": {420 "type": "string",421 "description": "Phone number associated with the billing address user"422 },423 "state": {424 "type": "string",425 "description": "A string indicating the state or province of the billing address"426 },427 "address": {428 "type": "string",429 "description": "\"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""430 },431 "country": {432 "type": "string",433 "description": "A string indicating the country of the address"434 },435 "pincode": {436 "type": "string",437 "description": "A string indicating the postal code or PIN code of the address area"438 },439 "version": {440 "type": "string",441 "description": "Address version, to be deprecated"442 },443 "address1": {444 "type": "string",445 "description": "\"A string representing the first line of the address, typically containing street or building information\""446 },447 "address2": {448 "type": "string",449 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""450 },451 "landmark": {452 "type": "string",453 "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""454 },455 "latitude": {456 "type": [457 "number",458 "string"459 ],460 "description": "The latitude of the address"461 },462 "area_code": {463 "type": "string",464 "x-not-enum": true,465 "description": "Area code of the address"466 },467 "last_name": {468 "type": "string",469 "description": "Last name of the individual associated with the billing address"470 },471 "longitude": {472 "type": [473 "number",474 "string"475 ],476 "description": "The longitude of the address"477 },478 "created_at": {479 "type": "string",480 "format": "date-time",481 "description": "Date and time when the billing address was created"482 },483 "first_name": {484 "type": "string",485 "description": "First name of the individual associated with the billing address"486 },487 "updated_at": {488 "type": "string",489 "format": "date-time",490 "description": "Date and time when the billing address was last updated"491 },492 "address_type": {493 "type": "string",494 "x-not-enum": true,495 "description": "Type of address (e.g., home, office, registered)"496 },497 "geo_location": {498 "required": [],499 "description": "Geographic coordinates (latitude and longitude) of the billing address",500 "type": "object",501 "properties": {502 "latitude": {503 "type": [504 "number",505 "string"506 ],507 "description": "The latitude of the geolocation"508 },509 "longitude": {510 "type": [511 "number",512 "string"513 ],514 "description": "The longitude of the geolocation"515 }516 }517 },518 "area_code_slug": {519 "type": "string",520 "description": "Unique identifier or slug for the area code associated with the address"521 },522 "contact_person": {523 "type": "string",524 "description": "Name of the contact person associated with the billing address"525 },526 "display_address": {527 "type": "string",528 "description": "Formatted display version of the billing address"529 },530 "address_category": {531 "type": "string",532 "x-not-enum": true,533 "description": "Category or classification of the delivery address"534 },535 "country_iso_code": {536 "type": "string",537 "x-not-enum": true,538 "description": "ISO code representing the country of the delivery address"539 },540 "country_phone_code": {541 "type": [542 "string",543 "null"544 ],545 "x-not-enum": true,546 "description": "Phone code for the country of the delivery address"547 }548 }549 },550 "delivery_partner_details": {551 "type": "object",552 "description": "Delivery Partner details",553 "properties": {554 "id": {555 "type": [556 "string",557 "number",558 "null"559 ],560 "description": "Unique identifier for the delivery partner"561 },562 "name": {563 "type": [564 "string",565 "null"566 ],567 "description": "Name of the delivery partner"568 },569 "awb_no": {570 "type": [571 "string",572 "null"573 ],574 "description": "Airway Bill (AWB) number associated with the delivery"575 },576 "eway_bill_id": {577 "type": [578 "string",579 "null"580 ],581 "description": "Electronic Way Bill (E-way Bill) ID for the delivery"582 },583 "track_url": {584 "type": [585 "string",586 "null"587 ],588 "description": "URL to track the delivery status or shipment details"589 },590 "gst_tag": {591 "type": [592 "string",593 "null"594 ],595 "description": "GST tag of the shipment"596 },597 "extension_id": {598 "type": [599 "string",600 "null"601 ],602 "description": "Unique Identifier of Courier partner Extension"603 },604 "scheme_id": {605 "type": [606 "string",607 "null"608 ],609 "description": "Unique identifier of a Courier partner scheme"610 },611 "courier_partner_slug": {612 "type": [613 "string",614 "null"615 ],616 "description": "Unique identifier containing extension_id and scheme_id"617 }618 },619 "required": [620 "id",621 "name",622 "awb_no",623 "eway_bill_id",624 "track_url",625 "gst_tag",626 "extension_id",627 "scheme_id",628 "courier_partner_slug"629 ]630 },631 "bags": {632 "type": "array",633 "description": "Details of all the products/articles in a shipment",634 "items": {635 "type": "object",636 "properties": {637 "financial_breakup": {638 "type": "array",639 "description": "Financial breakup of an item",640 "items": {641 "type": "object",642 "properties": {643 "brand_calculated_amount": {644 "type": "number",645 "description": "Effective selling price - Brand's additional discounts"646 },647 "discount": {648 "type": "number",649 "description": "The total amount discounted from the original MRP/actual price"650 },651 "gst_fee": {652 "type": "number",653 "description": "The fee associated with Goods and Services Tax (GST) for a product or service"654 },655 "gst_tax_percentage": {656 "type": "number",657 "description": "The percentage rate of GST applied to a product or service"658 },659 "gst_tag": {660 "type": [661 "string",662 "null"663 ],664 "description": "Type of GST applied - IGST, CGST, SGST"665 },666 "hsn_code": {667 "type": [668 "string",669 "null"670 ],671 "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"672 },673 "identifiers": {674 "type": "object",675 "description": "Product identifiers",676 "properties": {677 "sku_code": {678 "type": "string",679 "description": "SKU code of the product"680 }681 }682 },683 "price_marked": {684 "type": "number",685 "description": "The indicated price or value assigned to an item before any discounts or adjustments"686 },687 "tax_collected_at_source": {688 "type": "number",689 "description": "The tax amount collected at the source of income or transaction"690 },691 "tcs_percentage": {692 "type": "number",693 "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"694 },695 "total_units": {696 "type": "number",697 "description": "Total number of units of the item"698 },699 "value_of_good": {700 "type": "number",701 "description": "Effective selling price - Product GST Amount"702 },703 "item_name": {704 "type": "string",705 "description": "The name of the item being referenced"706 },707 "size": {708 "type": "string",709 "description": "The physical dimensions or specifications of the item, indicating its size or measurements"710 },711 "loyalty_discount": {712 "type": "number",713 "description": "Amount reduced from the payable price when the customer applies loyalty program points while placing the order"714 }715 },716 "required": [717 "brand_calculated_amount",718 "discount",719 "gst_fee",720 "gst_tax_percentage",721 "gst_tag",722 "hsn_code",723 "identifiers",724 "price_marked",725 "tax_collected_at_source",726 "tcs_percentage",727 "total_units",728 "value_of_good",729 "item_name",730 "size"731 ]732 }733 },734 "entity_type": {735 "type": "string"736 },737 "item": {738 "type": "object",739 "description": "Item details",740 "properties": {741 "l3_category_name": {742 "type": "string",743 "description": "The name of the level 3 category to which the item belongs"744 },745 "l1_category_id": {746 "type": "number",747 "description": "ID representing the level 2 category classification of the item"748 },749 "code": {750 "type": "string",751 "description": "A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes"752 },753 "branch_url": {754 "type": [755 "null",756 "string"757 ],758 "description": "Branch URL"759 },760 "l2_category": {761 "type": "array",762 "items": {763 "type": "string",764 "x-not-enum": true,765 "description": "The name of the level 2 category to which the item belongs"766 }767 },768 "l3_category": {769 "type": "number",770 "x-not-enum": true,771 "description": "ID representing the level 3 category classification of the item"772 },773 "last_updated_at": {774 "type": "string",775 "format": "date-time",776 "description": "Timestamp when the item was last updated"777 },778 "id": {779 "type": "number",780 "description": "ID of the item that is being referred"781 },782 "name": {783 "type": "string",784 "description": "The name of the item being referenced"785 },786 "can_return": {787 "type": "boolean",788 "description": "Flag indicating if the item is eligible for return"789 },790 "webstore_product_url": {791 "type": [792 "null",793 "string"794 ],795 "description": "Product URL"796 },797 "gender": {798 "type": [799 "null",800 "string"801 ],802 "description": "Gender associated with an item"803 },804 "l2_category_id": {805 "type": "number",806 "description": "ID representing the level 2 category classification of the item"807 },808 "color": {809 "type": [810 "null",811 "string"812 ],813 "description": "Color associated with and item"814 },815 "slug_key": {816 "type": "string",817 "description": "Automatically generated unique slug of the item"818 },819 "can_cancel": {820 "type": "boolean",821 "description": "Flag indicating if the item is eligible for cancellation"822 },823 "attributes": {824 "type": "object",825 "description": "An object containing descriptive properties of the item",826 "properties": {827 "name": {828 "type": "string",829 "description": "The name or title of the item"830 },831 "color": {832 "type": "string",833 "description": "The color description of the item"834 },835 "essential": {836 "type": "string",837 "description": "Indicates whether the item is considered essential"838 },839 "brand_name": {840 "type": "string",841 "description": "The brand name of the item"842 },843 "primary_color": {844 "type": "string",845 "description": "The primary color of the item"846 },847 "primary_color_hex": {848 "type": "string",849 "description": "The hexadecimal code representing the primary color"850 },851 "primary-colour-hex-code": {852 "type": "string",853 "description": "The hexadecimal code representing the primary color"854 },855 "media": {856 "type": "array",857 "description": "An array containing media files associated with the item",858 "items": {859 "type": "object"860 }861 }862 }863 },864 "brand_id": {865 "type": "number",866 "description": "The unique identifier associated with the brand of the item"867 },868 "brand": {869 "type": "string",870 "description": "The brand or manufacturer of the item"871 },872 "l1_category": {873 "type": "array",874 "items": {875 "type": "string",876 "x-not-enum": true,877 "description": "The name of the level 1 category to which the item belongs"878 }879 },880 "department_id": {881 "type": "number",882 "description": "The unique identifier representing the department or category to which the item belongs"883 },884 "size": {885 "type": "string",886 "description": "The size or dimensions of the item"887 },888 "image": {889 "type": "array",890 "items": {891 "type": "string",892 "description": "Url of the item's image"893 }894 }895 }896 },897 "brand": {898 "type": "object",899 "description": "Brand's information",900 "properties": {901 "credit_note_allowed": {902 "type": "boolean",903 "description": "If a credit note ID needs to be generated by the system"904 },905 "created_on": {906 "type": "string",907 "description": "Date and time when the brand was registered or created"908 },909 "id": {910 "type": "number",911 "description": "Unique identifier assigned to the brand for reference and identification"912 },913 "logo": {914 "type": "string",915 "description": "Visual representation or emblem associated with the brand"916 },917 "modified_on": {918 "type": "string",919 "description": "Date and time of the most recent update or modification to the brand's information"920 },921 "is_virtual_invoice": {922 "type": "boolean",923 "description": "If invoice ID needs to be generated by the system"924 },925 "brand_name": {926 "type": "string",927 "description": "Name or title of the brand used for identification and representation"928 }929 },930 "required": [931 "credit_note_allowed",932 "created_on",933 "id",934 "logo",935 "modified_on",936 "is_virtual_invoice",937 "brand_name"938 ]939 },940 "bag_id": {941 "type": "number"942 },943 "article": {944 "type": "object",945 "description": "Details of the article",946 "properties": {947 "identifiers": {948 "type": "object",949 "description": "Product identifiers",950 "properties": {951 "sku_code": {952 "type": "string"953 }954 }955 },956 "esp_modified": {957 "type": [958 "string",959 "boolean"960 ],961 "description": "Flag representing if effective selling price has been modified"962 },963 "size": {964 "type": "string",965 "description": "The physical dimensions or specifications of the article, indicating its size or measurements"966 },967 "code": {968 "type": "string",969 "description": "A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes"970 },971 "set": {972 "description": "Details of the set article containing size distribution",973 "type": "object",974 "properties": {975 "quantity": {976 "type": "integer",977 "description": "Number of units present"978 },979 "size_distribution": {980 "type": "object",981 "description": "Object indicating the distribution of size and quantity of a set article",982 "properties": {983 "sizes": {984 "type": "array",985 "description": "Array indicating size wise units present in a set article",986 "items": {987 "type": "object",988 "description": "Object indicating the size and quantity distribution of a set article",989 "properties": {990 "pieces": {991 "type": "integer",992 "description": "Number of units of a particular size"993 },994 "size": {995 "type": "string",996 "description": "Size of the article"997 }998 }999 }1000 }1001 }1002 }1003 }1004 },1005 "is_set": {1006 "type": [1007 "string",1008 "boolean"1009 ],1010 "description": "A boolean indicating whether the article is a set"1011 },1012 "seller_identifier": {1013 "type": "string",1014 "description": "Seller's identifier of the article"1015 },1016 "return_config": {1017 "type": "object",1018 "description": "Return configuration details of the article",1019 "properties": {1020 "time": {1021 "type": "number",1022 "description": "Number indicating number of hours or days"1023 },1024 "unit": {1025 "type": "string",1026 "description": "String indicating the unit of the time, eg. days, hours"1027 },1028 "returnable": {1029 "type": "boolean",1030 "description": "Flag indicating whether product is returnable or not"1031 }1032 },1033 "required": [1034 "time",1035 "unit",1036 "returnable"1037 ]1038 },1039 "_id": {1040 "type": "string",1041 "description": "DB generated ID of the article"1042 },1043 "uid": {1044 "type": "string",1045 "description": "UID of the article"1046 },1047 "child_details": {1048 "type": [1049 "object",1050 "array"1051 ],1052 "description": "Child article details if any",1053 "properties": {},1054 "required": []1055 },1056 "bundle_details": {1057 "type": "object",1058 "description": "Contains bundle-related metadata for the shipment.",1059 "properties": {1060 "bundle_group_id": {1061 "type": "string",1062 "description": "Unique group identifier for the bundle."1063 },1064 "name": {1065 "type": "string",1066 "description": "Name of the bundle."1067 },1068 "slug": {1069 "type": "string",1070 "description": "URL-friendly identifier for the bundle."1071 },1072 "price_marked": {1073 "type": "number",1074 "description": "Maximum Retail Price of the bundle."1075 },1076 "price_effective": {1077 "type": "number",1078 "description": "Current selling price of the bundle."1079 },1080 "item_id": {1081 "type": "integer",1082 "description": "Unique identifier for the item."1083 },1084 "item_type": {1085 "type": "string",1086 "description": "Type of the item (physical_bundle, virtual_bundle).",1087 "enum": [1088 "virtual_bundle",1089 "physical_bundle"1090 ]1091 },1092 "return_config": {1093 "description": "Refund Config for bundle product",1094 "type": "object",1095 "properties": {1096 "allow_partial_return": {1097 "type": "boolean",1098 "nullable": true,1099 "description": "The line number of the parent bag."1100 },1101 "returnable": {1102 "type": "boolean",1103 "nullable": true,1104 "description": "The line number of the parent bag."1105 },1106 "unit": {1107 "type": "boolean",1108 "nullable": true,1109 "description": "The line number of the parent bag."1110 },1111 "time": {1112 "type": "boolean",1113 "nullable": true,1114 "description": "The line number of the parent bag."1115 }1116 }1117 },1118 "seller_identifier": {1119 "type": "string",1120 "description": "Identifier for the seller of the bundle."1121 },1122 "images": {1123 "type": "array",1124 "items": {1125 "type": "string"1126 },1127 "description": "An array of image URLs associated with the bundle."1128 },1129 "bundle_article_quantity": {1130 "type": "integer",1131 "description": "Article net_quantity in bundle Product."1132 },1133 "brand_name": {1134 "type": "string",1135 "description": "Identifier for the brand name."1136 },1137 "size": {1138 "type": "string",1139 "description": "Size associated with the bundle item."1140 }1141 }1142 },1143 "dimensions": {1144 "description": "The dimension object of the article/item",1145 "required": [],1146 "type": "object",1147 "properties": {1148 "height": {1149 "type": [1150 "number",1151 "null"1152 ],1153 "description": "The height of the product"1154 },1155 "width": {1156 "type": [1157 "number",1158 "null"1159 ],1160 "description": "The width of the product"1161 },1162 "is_default": {1163 "type": [1164 "boolean",1165 "null"1166 ],1167 "description": "Whether the dimension is the default one or not"1168 },1169 "unit": {1170 "type": [1171 "string",1172 "null"1173 ],1174 "description": "The unit of dimension"1175 },1176 "length": {1177 "type": [1178 "number",1179 "null"1180 ],1181 "description": "The length of the product"1182 }1183 }1184 },1185 "weight": {1186 "required": [],1187 "type": "object",1188 "description": "Object containing weight details of item/article",1189 "properties": {1190 "unit": {1191 "type": "string",1192 "description": "The unit of weight",1193 "example": "kg"1194 },1195 "shipping": {1196 "type": "number",1197 "description": "The shipping weight of the product",1198 "example": 1.51199 },1200 "is_default": {1201 "type": "boolean",1202 "description": "Whether the weight is the default one or not",1203 "example": true1204 }1205 }1206 },1207 "currency": {1208 "type": "object",1209 "description": "Order currency details",1210 "properties": {1211 "code": {1212 "type": "string",1213 "description": "Currency code"1214 },1215 "rate": {1216 "type": "number",1217 "description": "The conversion rate value"1218 }1219 },1220 "required": []1221 },1222 "expiration_date": {}1223 },1224 "required": [1225 "identifiers",1226 "esp_modified",1227 "size",1228 "code",1229 "set",1230 "is_set",1231 "seller_identifier",1232 "return_config",1233 "_id",1234 "uid",1235 "child_details",1236 "dimensions",1237 "weight",1238 "currency",1239 "expiration_date"1240 ]1241 },1242 "current_operational_status": {1243 "type": "object",1244 "properties": {1245 "created_at": {1246 "type": "string",1247 "format": "date-time",1248 "description": "Date and time when the shipment status record was created"1249 },1250 "created_ts": {1251 "type": "string",1252 "description": "Timestamp indicating the exact time when the shipment status record was created"1253 },1254 "id": {1255 "type": "number",1256 "description": "Unique identifier for the shipment status record"1257 },1258 "kafka_sync": {1259 "type": "boolean",1260 "description": "Flag indicating whether the shipment status update has been sync with Kafka"1261 },1262 "updated_ts": {1263 "type": "string",1264 "description": "Timestamp indicating the last time the shipment status record was updated"1265 },1266 "updated_at": {1267 "type": "string",1268 "format": "date-time",1269 "description": "Date and time of the most recent update to the shipment status record"1270 },1271 "delivery_partner_id": {1272 "type": [1273 "integer",1274 "null"1275 ],1276 "description": "Unique identifier of delivery partner"1277 },1278 "shipment_id": {1279 "type": "string",1280 "description": "Unique shipment no. that is auto-generated"1281 },1282 "store_id": {1283 "type": "number",1284 "description": "ID of the fulfilling store of the shipment"1285 },1286 "status": {1287 "type": "string",1288 "description": "Current operational status of the shipment"1289 },1290 "bag_id": {1291 "type": "number",1292 "description": "The unique identifier associated with the bag"1293 },1294 "state_id": {1295 "type": "number",1296 "description": "The unique identifier associated with the state"1297 },1298 "state_type": {1299 "type": "string",1300 "enum": [1301 "operational",1302 "logistics",1303 "financial"1304 ],1305 "description": "Type of the state - operational, logistics, financial"1306 },1307 "delivery_awb_number": {1308 "type": [1309 "string",1310 "null"1311 ],1312 "description": "Airway Bill (AWB) number associated with the delivery"1313 },1314 "bag_state_mapper": {1315 "type": "object",1316 "description": "Object representing properties of the state",1317 "properties": {1318 "journey_type": {1319 "type": [1320 "string",1321 "null"1322 ],1323 "enum": [1324 "forward",1325 "return"1326 ],1327 "description": "Journey type can be forward or return"1328 },1329 "app_display_name": {1330 "type": "string",1331 "description": "The display name of a shipment status as it appears on the sale channel's website"1332 },1333 "state_type": {1334 "type": "string",1335 "enum": [1336 "operational",1337 "logistics",1338 "financial"1339 ],1340 "description": "Type of the state - operational, logistics, financial"1341 },1342 "app_state_name": {1343 "type": "string",1344 "description": "The slug of a shipment status from the sale channel's front"1345 },1346 "name": {1347 "type": "string",1348 "description": "The slug of a shipment status from the platform's front"1349 },1350 "app_facing": {1351 "type": "boolean",1352 "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"1353 },1354 "id": {1355 "type": "number",1356 "description": "The unique identifier associated with the state"1357 },1358 "display_name": {1359 "type": "string",1360 "description": "The display name of a shipment status as it appears on the platform"1361 },1362 "is_active": {1363 "type": "boolean",1364 "description": "A boolean flag indicating whether a state is active or not"1365 }1366 },1367 "required": [1368 "journey_type",1369 "app_display_name",1370 "state_type",1371 "app_state_name",1372 "name",1373 "app_facing",1374 "id",1375 "display_name",1376 "is_active"1377 ]1378 },1379 "reasons": {1380 "type": "array",1381 "items": {1382 "type": "object",1383 "properties": {1384 "slug": {1385 "type": "string",1386 "description": "System generated slug"1387 },1388 "display_name": {1389 "type": "string",1390 "description": "Text that is displayed on the application front"1391 },1392 "id": {1393 "type": "integer",1394 "description": "System generated ID of the reason object"1395 },1396 "state": {1397 "type": [1398 "integer",1399 "string"1400 ],1401 "description": "State associated with the reason"1402 },1403 "text": {1404 "type": "string",1405 "description": "Reason text"1406 },1407 "quantity": {1408 "type": "integer",1409 "description": "No of quantity that is being cancelled"1410 },1411 "inventory_flag": {1412 "type": "boolean",1413 "description": "Inventory depletion action to be taken or not"1414 }1415 }1416 },1417 "description": "Reasons associated with the current shipment's status"1418 },1419 "action_user": {1420 "description": "Details of the user who initiated the change in the shipment's status",1421 "required": [],1422 "type": "object",1423 "properties": {1424 "title": {1425 "type": "string",1426 "description": "The title of the user eg. Staff, Admin",1427 "example": "Staff"1428 },1429 "user_id": {1430 "type": "string",1431 "description": "System generated ID associated with the user",1432 "example": "23546659"1433 },1434 "user_name": {1435 "type": "string",1436 "description": "System generated username associated with the user",1437 "example": "65967faf620ff7c9db513d9c"1438 },1439 "order_role": {1440 "type": "string",1441 "description": "Order role associated with the user eg. company_operation, store_manager",1442 "example": "full_access"1443 },1444 "employee_code": {1445 "type": "string",1446 "x-not-enum": true,1447 "description": "Employee code associated with the user",1448 "example": "EM-102"1449 }1450 }1451 }1452 },1453 "required": [1454 "created_at",1455 "created_ts",1456 "id",1457 "kafka_sync",1458 "updated_ts",1459 "updated_at",1460 "delivery_partner_id",1461 "shipment_id",1462 "store_id",1463 "status",1464 "bag_id",1465 "state_id",1466 "state_type",1467 "delivery_awb_number",1468 "bag_state_mapper",1469 "reasons",1470 "action_user"1471 ]1472 },1473 "affiliate_bag_details": {1474 "type": "object",1475 "description": "Object containing external bag details like external order id, external bag id",1476 "properties": {1477 "affiliate_bag_id": {1478 "type": "string",1479 "description": "External bag id"1480 },1481 "affiliate_order_id": {1482 "type": "string",1483 "description": "External order id"1484 }1485 },1486 "required": [1487 "affiliate_bag_id",1488 "affiliate_order_id"1489 ]1490 },1491 "payment_methods": {1492 "type": "object",1493 "description": "\"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details.\""1494 },1495 "quantity": {1496 "type": "number",1497 "description": "Total quantity of the article present in the bag."1498 },1499 "prices": {1500 "type": "object",1501 "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",1502 "properties": {1503 "price_effective": {1504 "type": "number",1505 "description": "MRP - Initial Seller provided discount"1506 },1507 "discount": {1508 "type": "number",1509 "description": "The total amount discounted from the original MRP/actual price"1510 },1511 "amount_paid": {1512 "type": "number",1513 "description": "Amount paid by the customer"1514 },1515 "coupon_effective_discount": {1516 "type": "number",1517 "description": "Coupon provided by brand or seller"1518 },1519 "delivery_charge": {1520 "type": "number",1521 "description": "The fee associated with the delivery service for transporting the item to its destination"1522 },1523 "fynd_credits": {1524 "type": "number",1525 "description": "Credits provided by Fynd"1526 },1527 "cod_charges": {1528 "type": "number",1529 "description": "The fee associated with the COD order"1530 },1531 "refund_credit": {1532 "type": "number",1533 "description": "Refund credits provided to the customer"1534 },1535 "cashback": {1536 "type": "number",1537 "description": "Cashback points"1538 },1539 "refund_amount": {1540 "type": "number",1541 "description": "Amount to be refunded on cancellation and return"1542 },1543 "added_to_fynd_cash": {1544 "type": "boolean",1545 "description": "Flag indicating whether fynd cash has been used"1546 },1547 "cashback_applied": {1548 "type": "number",1549 "description": "Cashback applied on the order"1550 },1551 "gst_tax_percentage": {1552 "type": "number",1553 "description": "The percentage rate of GST applied to a product or service"1554 },1555 "value_of_good": {1556 "type": "number",1557 "description": "Effective selling price - Product GST Amount"1558 },1559 "price_marked": {1560 "type": "number",1561 "description": "The indicated price or value assigned to an item before any discounts or adjustments"1562 },1563 "transfer_price": {1564 "type": "number",1565 "description": "article"1566 },1567 "brand_calculated_amount": {1568 "type": "number",1569 "description": "Price Effective - Coupon Discount (Seller) - Promotion (Seller)"1570 },1571 "tax_collected_at_source": {1572 "type": "number",1573 "description": "The tax amount collected at the source of income or transaction"1574 },1575 "tcs_percentage": {1576 "type": "number",1577 "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"1578 },1579 "promotion_effective_discount": {1580 "type": "number",1581 "description": "Effective promotion discount including promotions given by seller and Platform"1582 },1583 "gift_price": {1584 "type": "number",1585 "description": "Gift card amount used"1586 },1587 "coupon_value": {1588 "type": "number",1589 "description": "Stores the coupon value as shown in the cart"1590 },1591 "seller_promotion_effective_discount": {1592 "type": "number",1593 "description": "Promotion discount given by the seller"1594 },1595 "fynd_promotion_effective_discount": {1596 "type": "number",1597 "description": "Promotion discount given by Platform/fynd"1598 },1599 "amount_paid_roundoff": {1600 "type": "number",1601 "description": "Amount paid rounded off"1602 },1603 "loyalty_discount": {1604 "type": "number",1605 "description": "Amount reduced from the payable price when the customer applies loyalty program points while placing the order"1606 }1607 },1608 "required": [1609 "price_effective",1610 "discount",1611 "amount_paid",1612 "coupon_effective_discount",1613 "delivery_charge",1614 "fynd_credits",1615 "cod_charges",1616 "refund_credit",1617 "cashback",1618 "refund_amount",1619 "added_to_fynd_cash",1620 "cashback_applied",1621 "gst_tax_percentage",1622 "value_of_good",1623 "price_marked",1624 "transfer_price",1625 "brand_calculated_amount",1626 "tax_collected_at_source",1627 "tcs_percentage",1628 "promotion_effective_discount",1629 "gift_price",1630 "coupon_value",1631 "seller_promotion_effective_discount",1632 "fynd_promotion_effective_discount",1633 "amount_paid_roundoff"1634 ]1635 },1636 "order_created": {1637 "type": "string",1638 "description": "Order creation timestamp"1639 },1640 "gst_details": {1641 "type": "object",1642 "description": "GST details associated with the bag",1643 "properties": {1644 "gstin_code": {1645 "type": [1646 "string",1647 "null"1648 ],1649 "x-not-enum": true,1650 "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"1651 },1652 "gst_tag": {1653 "type": [1654 "string",1655 "null"1656 ],1657 "description": "Type of GST applied - IGST, CGST, SGST"1658 },1659 "hsn_code": {1660 "type": [1661 "string",1662 "null"1663 ],1664 "x-not-enum": true,1665 "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"1666 },1667 "value_of_good": {1668 "type": "number",1669 "description": "Effective selling price - Product GST Amount"1670 },1671 "gst_tax_percentage": {1672 "type": "number",1673 "description": "The percentage rate of GST applied to a product or service"1674 },1675 "is_default_hsn_code": {1676 "type": "boolean"1677 },1678 "brand_calculated_amount": {1679 "type": "number",1680 "description": "Effective selling price - Brand's additional discounts"1681 },1682 "tax_collected_at_source": {1683 "type": "number",1684 "description": "The tax amount collected at the source of income or transaction"1685 },1686 "hsn_code_id": {1687 "type": [1688 "string",1689 "null"1690 ],1691 "description": "The unique identifier associated with HSN code"1692 },1693 "gst_fee": {1694 "type": "number",1695 "description": "The fee associated with Goods and Services Tax (GST) for a product or service"1696 },1697 "igst_tax_percentage": {1698 "type": "number",1699 "description": "Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions"1700 },1701 "sgst_tax_percentage": {1702 "type": "number",1703 "description": "Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state"1704 },1705 "cgst_tax_percentage": {1706 "type": "number",1707 "description": "Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state"1708 },1709 "igst_gst_fee": {1710 "type": [1711 "string",1712 "number"1713 ],1714 "description": "Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions"1715 },1716 "cgst_gst_fee": {1717 "type": "string",1718 "description": "Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state"1719 },1720 "sgst_gst_fee": {1721 "type": "string",1722 "description": "Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state"1723 },1724 "tax_rule_id": {1725 "type": "string",1726 "description": "ID of the tax rule associated with the product"1727 }1728 },1729 "required": [1730 "gstin_code",1731 "gst_tag",1732 "hsn_code",1733 "value_of_good",1734 "gst_tax_percentage",1735 "is_default_hsn_code",1736 "brand_calculated_amount",1737 "tax_collected_at_source",1738 "hsn_code_id",1739 "gst_fee",1740 "igst_tax_percentage",1741 "sgst_tax_percentage",1742 "cgst_tax_percentage",1743 "igst_gst_fee",1744 "cgst_gst_fee",1745 "sgst_gst_fee"1746 ]1747 },1748 "line_number": {1749 "type": "number",1750 "description": "Unique identifier associated with each bag in a shipment"1751 },1752 "applied_promos": {1753 "type": "array",1754 "description": "Details of the applied promotions",1755 "items": {1756 "type": "object",1757 "properties": {1758 "promo_id": {1759 "type": "string",1760 "description": "Promotion id"1761 },1762 "buy_rules": {1763 "description": "Buy rules for promotions",1764 "type": "array",1765 "items": {1766 "type": "object",1767 "properties": {1768 "item_criteria": {1769 "type": "object",1770 "description": "Item criteria of promotion"1771 },1772 "cart_conditions": {1773 "type": "object",1774 "description": "Cart conditions details for promotion"1775 }1776 }1777 }1778 },1779 "offer_text": {1780 "type": "string",1781 "description": "Offer text of current promotion"1782 },1783 "promotion_group": {1784 "type": "string",1785 "description": "Promotion group for the promotion"1786 },1787 "mrp_promotion": {1788 "type": "boolean",1789 "description": "If applied promotion is applied on product MRP or ESP"1790 },1791 "promotion_name": {1792 "type": "string",1793 "description": "Promotion name of current promotion"1794 },1795 "amount": {1796 "type": "number",1797 "description": "Per unit discount amount applied with current promotion"1798 },1799 "discount_rules": {1800 "description": "Discount rules for promotions",1801 "type": "array",1802 "items": {1803 "type": "object",1804 "properties": {1805 "matched_buy_rules": {1806 "type": "array",1807 "description": "Matched buy rules for promotion",1808 "items": {1809 "type": "string"1810 }1811 },1812 "raw_offer": {1813 "type": "object",1814 "description": "raw offer details for promotion"1815 },1816 "offer": {1817 "type": "object",1818 "description": "offer for promotion"1819 },1820 "item_criteria": {1821 "type": "object",1822 "description": "Item criteria of promotion"1823 }1824 }1825 }1826 },1827 "ownership": {1828 "type": "object",1829 "description": "Ownership of promotion",1830 "properties": {1831 "payable_category": {1832 "type": "string",1833 "x-not-enum": true,1834 "description": "promo amount payable category"1835 },1836 "payable_by": {1837 "type": "string",1838 "description": "promo amount bearable party"1839 }1840 }1841 },1842 "article_quantity": {1843 "type": "integer",1844 "description": "Quantity of article on which promotion is applicable"1845 },1846 "applied_free_articles": {1847 "description": "Applied free article for free gift item promotions",1848 "type": "array",1849 "items": {1850 "type": "object",1851 "properties": {1852 "free_gift_item_details": {1853 "description": "Free gift items details",1854 "type": "object",1855 "properties": {1856 "item_slug": {1857 "type": "string",1858 "description": "item slug"1859 },1860 "item_name": {1861 "type": "string",1862 "description": "Item name"1863 },1864 "item_price_details": {1865 "type": "object",1866 "description": "item price details"1867 },1868 "item_brand_name": {1869 "type": "string",1870 "description": "item brand name"1871 },1872 "item_id": {1873 "type": "integer",1874 "description": "Item id"1875 },1876 "item_images_url": {1877 "type": "array",1878 "description": "item images URL",1879 "items": {1880 "type": "string"1881 }1882 }1883 }1884 },1885 "parent_item_identifier": {1886 "type": "string",1887 "description": "Parent item identifier for free article"1888 },1889 "quantity": {1890 "type": "integer",1891 "description": "Free article quantity"1892 },1893 "article_id": {1894 "type": "string",1895 "description": "free article id"1896 }1897 }1898 }1899 },1900 "promotion_type": {1901 "type": "string",1902 "x-not-enum": true,1903 "description": "Promotion type of current promotion"1904 },1905 "meta": {1906 "type": "object",1907 "additionalProperties": true,1908 "description": "Meta object for extra data"1909 },1910 "code": {1911 "type": [1912 "string",1913 "null"1914 ],1915 "description": "Promotion code"1916 }1917 }1918 }1919 },1920 "taxes": {1921 "type": "array",1922 "description": "Details of taxes applied on products",1923 "items": {1924 "type": "object",1925 "properties": {1926 "name": {1927 "type": "string",1928 "description": "Name of the tax applied (e.g., GST, CGST, SGST, VAT)"1929 },1930 "rate": {1931 "type": "number",1932 "description": "Tax rate applied, represented as a decimal value (e.g., 0.09 for 9%)"1933 },1934 "taxable_amount": {1935 "type": "number",1936 "description": "Amount on which the tax is calculated, after applicable discounts or exemptions"1937 },1938 "tax_amount": {1939 "type": "number",1940 "description": "Final tax amount calculated using the tax rate on the taxable amount"1941 }1942 }1943 }1944 }1945 },1946 "required": [1947 "financial_breakup",1948 "entity_type",1949 "item",1950 "brand",1951 "bag_id",1952 "article",1953 "current_operational_status",1954 "affiliate_bag_details",1955 "payment_methods",1956 "quantity",1957 "prices",1958 "order_created",1959 "gst_details",1960 "line_number",1961 "applied_promos",1962 "taxes"1963 ]1964 }1965 },1966 "bag_status_history": {1967 "type": "array",1968 "description": "Records the changes in status for a bag, providing a timeline of events and transitions",1969 "items": {1970 "type": "object",1971 "properties": {1972 "created_at": {1973 "type": "string",1974 "format": "date-time",1975 "description": "Date and time when the bag status history record was created."1976 },1977 "created_ts": {1978 "type": "string",1979 "description": "Timestamp indicating the exact time when the bag status history record was created"1980 },1981 "id": {1982 "type": "number",1983 "description": "Unique identifier for the bag status history record"1984 },1985 "kafka_sync": {1986 "type": "boolean",1987 "description": "Flag indicating whether the bag status history update has been sync with Kafka"1988 },1989 "updated_ts": {1990 "type": "string",1991 "description": "Timestamp indicating the last time the bag status history record was updated"1992 },1993 "updated_at": {1994 "format": "date-time",1995 "type": "string",1996 "description": "Date and time of the most recent update to the bag status history record"1997 },1998 "delivery_partner_id": {1999 "type": [2000 "integer",2001 "null"2002 ],2003 "description": "Unique identifier of delivery partner"2004 },2005 "shipment_id": {2006 "type": "string",2007 "description": "Unique shipment no. that is auto-generated"2008 },2009 "store_id": {2010 "type": "number",2011 "description": "Store id associated with the bag"2012 },2013 "status": {2014 "type": "string",2015 "description": "Webhook shipment status, i.e., either create or update"2016 },2017 "bag_id": {2018 "type": "number",2019 "description": "The unique identifier associated with the bag"2020 },2021 "state_id": {2022 "type": "number",2023 "description": "The unique identifier associated with the state"2024 },2025 "state_type": {2026 "type": "string",2027 "enum": [2028 "operational",2029 "logistics",2030 "financial"2031 ],2032 "description": "Type of the state - operational, logistics, financial"2033 },2034 "delivery_awb_number": {2035 "type": [2036 "string",2037 "null"2038 ],2039 "description": "Airway Bill (AWB) number associated with the delivery"2040 },2041 "bag_state_mapper": {2042 "type": "object",2043 "description": "Object representing properties of the state",2044 "properties": {2045 "journey_type": {2046 "type": [2047 "string",2048 "null"2049 ],2050 "enum": [2051 "forward",2052 "return"2053 ],2054 "description": "Journey type can be forward or return"2055 },2056 "app_display_name": {2057 "type": "string",2058 "description": "The display name of a shipment status as it appears on the sale channel's website"2059 },2060 "state_type": {2061 "type": "string",2062 "enum": [2063 "operational",2064 "logistics",2065 "financial"2066 ],2067 "description": "Type of the state - operational, logistics, financial"2068 },2069 "app_state_name": {2070 "type": "string",2071 "description": "The slug of a shipment status from the sale channel's front"2072 },2073 "name": {2074 "type": "string",2075 "description": "The slug of a shipment status from the platform's front"2076 },2077 "app_facing": {2078 "type": "boolean",2079 "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"2080 },2081 "id": {2082 "type": "number",2083 "description": "The unique identifier associated with the state"2084 },2085 "display_name": {2086 "type": "string",2087 "description": "The display name of a shipment status as it appears on the platform"2088 },2089 "is_active": {2090 "type": "boolean",2091 "description": "A boolean flag indicating whether a state is active or not"2092 }2093 },2094 "required": [2095 "journey_type",2096 "app_display_name",2097 "state_type",2098 "app_state_name",2099 "name",2100 "app_facing",2101 "id",2102 "display_name",2103 "is_active"2104 ]2105 },2106 "reasons": {2107 "type": "array",2108 "items": {2109 "type": "object",2110 "properties": {2111 "slug": {2112 "type": "string",2113 "description": "System generated slug"2114 },2115 "display_name": {2116 "type": "string",2117 "description": "Text that is displayed on the application front"2118 },2119 "id": {2120 "type": "integer",2121 "description": "System generated ID of the reason object"2122 },2123 "state": {2124 "type": [2125 "integer",2126 "string"2127 ],2128 "description": "State associated with the reason"2129 },2130 "text": {2131 "type": "string",2132 "description": "Reason text"2133 },2134 "quantity": {2135 "type": "integer",2136 "description": "No of quantity that is being cancelled"2137 },2138 "inventory_flag": {2139 "type": "boolean",2140 "description": "Inventory depletion action to be taken or not"2141 }2142 }2143 },2144 "description": "Reasons associated with the current shipment's status"2145 },2146 "action_user": {2147 "type": "object",2148 "properties": {2149 "title": {2150 "type": "string",2151 "description": "The title of the user eg. Staff, Admin",2152 "example": "Staff"2153 },2154 "user_id": {2155 "type": "string",2156 "description": "System generated ID associated with the user",2157 "example": "23546659"2158 },2159 "user_name": {2160 "type": "string",2161 "description": "System generated username associated with the user",2162 "example": "65967faf620ff7c9db513d9c"2163 },2164 "order_role": {2165 "type": "string",2166 "description": "Order role associated with the user eg. company_operation, store_manager",2167 "example": "full_access"2168 },2169 "employee_code": {2170 "type": "string",2171 "x-not-enum": true,2172 "description": "Employee code associated with the user",2173 "example": "EM-102"2174 }2175 },2176 "required": []2177 }2178 },2179 "required": [2180 "created_at",2181 "created_ts",2182 "id",2183 "kafka_sync",2184 "updated_ts",2185 "updated_at",2186 "delivery_partner_id",2187 "shipment_id",2188 "store_id",2189 "status",2190 "bag_id",2191 "state_id",2192 "state_type",2193 "delivery_awb_number",2194 "bag_state_mapper",2195 "reasons",2196 "action_user"2197 ]2198 }2199 },2200 "fulfilling_store": {2201 "description": "Details of the store responsible for fulfilling the order",2202 "type": "object",2203 "properties": {2204 "id": {2205 "type": "number",2206 "description": "Unique identifier for the store."2207 },2208 "code": {2209 "type": "string",2210 "description": "Alphanumeric code representing the store."2211 },2212 "name": {2213 "type": "string",2214 "description": "Name of the store."2215 },2216 "address": {2217 "type": "string",2218 "description": "Physical address of the store."2219 },2220 "state": {2221 "type": "string",2222 "description": "State where the store is located."2223 },2224 "city": {2225 "type": "string",2226 "description": "City where the store is located."2227 },2228 "pincode": {2229 "type": "string",2230 "description": "Postal code (pincode) of the store's location."2231 },2232 "country": {2233 "type": "string",2234 "description": "Country where the store is situated."2235 },2236 "phone": {2237 "type": "string",2238 "description": "Contact phone number for the store."2239 },2240 "fulfillment_channel": {2241 "type": "string",2242 "description": "Type of fulfillment channel used by the store."2243 },2244 "location_type": {2245 "type": "string",2246 "enum": [2247 "high_street",2248 "mall",2249 "store",2250 "warehouse"2251 ],2252 "description": "Type of location e.g., warehouse, high_street"2253 },2254 "company_id": {2255 "type": "number",2256 "description": "Identifier of the company responsible for fulfilling shipments from this store"2257 },2258 "is_active": {2259 "type": "boolean",2260 "description": "Boolean indicating whether the store is currently active"2261 },2262 "tags": {2263 "type": "array",2264 "items": {2265 "type": "string"2266 },2267 "description": "Array of tags associated with the store"2268 }2269 },2270 "required": [2271 "id",2272 "code",2273 "name",2274 "address",2275 "state",2276 "city",2277 "pincode",2278 "country",2279 "phone",2280 "fulfillment_channel",2281 "location_type",2282 "company_id",2283 "is_active",2284 "tags"2285 ]2286 },2287 "prices": {2288 "type": "object",2289 "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",2290 "properties": {2291 "amount_paid": {2292 "type": "number",2293 "description": "Amount paid by the customer"2294 },2295 "refund_amount": {2296 "type": "number",2297 "description": "Amount to be refunded on cancellation and return"2298 },2299 "price_marked": {2300 "type": "number",2301 "description": "The indicated price or value assigned to an item before any discounts or adjustments"2302 },2303 "cod_charges": {2304 "type": "number",2305 "description": "The fee associated with the COD order"2306 },2307 "discount": {2308 "type": "number",2309 "description": "The total amount discounted from the original MRP/actual price"2310 },2311 "cashback_applied": {2312 "type": "number",2313 "description": "Cashback applied on the order"2314 },2315 "delivery_charge": {2316 "type": "number",2317 "description": "The fee associated with the delivery service for transporting the item to its destination"2318 },2319 "fynd_credits": {2320 "type": "number",2321 "description": "Credits provided by Fynd"2322 },2323 "cashback": {2324 "type": "number",2325 "description": "Cashback points"2326 },2327 "price_effective": {2328 "type": "number",2329 "description": "MRP - Initial Seller provided discount"2330 },2331 "refund_credit": {2332 "type": "number",2333 "description": "Refund credits provided to the customer"2334 },2335 "value_of_good": {2336 "type": "number",2337 "description": "Effective selling price - Product GST Amount"2338 },2339 "coupon_value": {2340 "type": "number",2341 "description": "Stores the coupon value as shown in the cart"2342 },2343 "tax_collected_at_source": {2344 "type": "number",2345 "description": "The tax amount collected at the source of income or transaction"2346 },2347 "promotion_effective_discount": {2348 "type": "number",2349 "description": "Effective promotion discount including promotions given by seller and Platform"2350 },2351 "fynd_promotion_effective_discount": {2352 "type": "number",2353 "description": "Promotion discount given by Platform/fynd"2354 },2355 "seller_promotion_effective_discount": {2356 "type": "number",2357 "description": "Promotion discount given by the seller"2358 },2359 "cn_refund_amount": {2360 "type": "number",2361 "description": "Amount to be refunded through credit note"2362 },2363 "gift_price": {2364 "type": "number",2365 "description": "Gift card amount used"2366 },2367 "amount_paid_roundoff": {2368 "type": "number",2369 "description": "Amount paid rounded off"2370 },2371 "loyalty_discount": {2372 "type": "number",2373 "description": "Amount reduced from the payable price when the customer applies loyalty program points while placing the order"2374 }2375 },2376 "required": [2377 "amount_paid",2378 "refund_amount",2379 "price_marked",2380 "cod_charges",2381 "discount",2382 "cashback_applied",2383 "delivery_charge",2384 "fynd_credits",2385 "cashback",2386 "price_effective",2387 "refund_credit",2388 "value_of_good",2389 "coupon_value",2390 "tax_collected_at_source",2391 "promotion_effective_discount",2392 "fynd_promotion_effective_discount",2393 "seller_promotion_effective_discount",2394 "cn_refund_amount",2395 "gift_price"2396 ]2397 },2398 "payments": {2399 "type": "object",2400 "description": "Object containing payment mode and payment breakup",2401 "properties": {2402 "id": {2403 "type": "number",2404 "description": "Unique identifier for the payment mode"2405 },2406 "mode": {2407 "type": "string",2408 "description": "Type or category of the payment mode (e.g., PP, COD)"2409 },2410 "logo": {2411 "type": "string",2412 "description": "URL or path to the logo/icon representing the payment mode"2413 },2414 "display_name": {2415 "type": "string",2416 "description": "Name or label used to display the payment mode"2417 },2418 "display_priority": {2419 "type": "number",2420 "description": "Priority order for displaying the payment mode"2421 },2422 "source": {2423 "type": "string",2424 "description": "Merchant of the payment mode (e.g., PartnerPay, JioPp)"2425 },2426 "is_active": {2427 "type": "boolean",2428 "description": "Boolean indicating whether the payment mode is currently active"2429 }2430 },2431 "required": [2432 "id",2433 "mode",2434 "logo",2435 "display_name",2436 "display_priority",2437 "source",2438 "is_active"2439 ]2440 },2441 "affiliate_details": {2442 "type": "object",2443 "description": "Application related details like config, order_id, shipment id",2444 "properties": {2445 "id": {2446 "type": [2447 "string",2448 "number"2449 ],2450 "description": "Identifier for the application, can be application_id or extension_id"2451 },2452 "affiliate_bag_id": {2453 "type": "string",2454 "description": "Identifier assigned by the application for the bag"2455 },2456 "affiliate_order_id": {2457 "type": "string",2458 "description": "Identifier of the order assigned by the application"2459 },2460 "company_affiliate_tag": {2461 "type": "string",2462 "description": "Tag associated with the bag from the application's company"2463 },2464 "affiliate_id": {2465 "type": "string",2466 "description": "Identifier for the application, can be application_id or extension_id"2467 },2468 "affiliate_shipment_id": {2469 "type": "string",2470 "description": "Identifier of the shipment assigned by the application"2471 },2472 "affiliate_store_id": {2473 "type": "string",2474 "description": "Identifier of the store assigned by the application"2475 },2476 "pdf_links": {2477 "type": "object",2478 "description": "PDF Links pushed by the application or extension",2479 "properties": {2480 "label_type": {2481 "type": "string",2482 "description": "Label type - external"2483 },2484 "invoice_type": {2485 "type": "string",2486 "description": "Invoice type - external"2487 },2488 "label": {2489 "type": "string",2490 "description": "Label URL provided by the application or extension"2491 },2492 "invoice": {2493 "type": "string",2494 "description": "Invoice URL provided by the application or extension"2495 }2496 },2497 "required": [2498 "label_type",2499 "invoice_type"2500 ]2501 },2502 "config": {2503 "type": "object",2504 "description": "Application configuration details",2505 "properties": {2506 "id": {2507 "type": [2508 "string",2509 "number"2510 ],2511 "description": "Identifier for the application, can be application_id or extension_id"2512 },2513 "name": {2514 "type": "string",2515 "description": "Application name"2516 },2517 "token": {2518 "type": [2519 "null",2520 "string"2521 ],2522 "description": "Application token - deprecated"2523 },2524 "dp_assignment": {2525 "type": "boolean",2526 "description": "Flag indicating whether auto DP assignment should happen from system"2527 },2528 "app_company_id": {2529 "type": [2530 "number",2531 "null",2532 "string"2533 ],2534 "description": "ID of the company from which order was placed"2535 },2536 "article_assignment": {2537 "description": "The article assignment settings",2538 "type": "object",2539 "properties": {2540 "strategy": {2541 "type": "string",2542 "enum": [2543 "optimal",2544 "low-price"2545 ]2546 },2547 "level": {2548 "type": "string",2549 "enum": [2550 "multi-companies",2551 "single-company",2552 "single-store"2553 ]2554 }2555 },2556 "required": []2557 },2558 "force_reassignment": {2559 "type": "boolean",2560 "description": "Indicates whether force reassignment is enabled"2561 },2562 "sales_channel_logo": {2563 "type": "string",2564 "description": "Logo URL of the application to which order belongs"2565 },2566 "ordering_channel_logo": {2567 "type": "string",2568 "description": "Logo URL of the ordering channel"2569 },2570 "post_order_reassignment": {2571 "type": "boolean",2572 "description": "Indicates whether post-order reassignment is enabled"2573 }2574 }2575 }2576 },2577 "required": [2578 "id",2579 "affiliate_bag_id",2580 "affiliate_order_id",2581 "company_affiliate_tag",2582 "affiliate_id",2583 "affiliate_shipment_id",2584 "affiliate_store_id",2585 "pdf_links",2586 "config"2587 ]2588 },2589 "dp_details": {2590 "type": "object",2591 "description": "Delivery Partner details",2592 "properties": {2593 "id": {2594 "type": [2595 "string",2596 "number",2597 "null"2598 ],2599 "description": "Unique identifier for the delivery partner"2600 },2601 "name": {2602 "type": [2603 "string",2604 "null"2605 ],2606 "description": "Name of the delivery partner"2607 },2608 "awb_no": {2609 "type": [2610 "string",2611 "null"2612 ],2613 "description": "Airway Bill (AWB) number associated with the delivery"2614 },2615 "eway_bill_id": {2616 "type": [2617 "string",2618 "null"2619 ],2620 "description": "Electronic Way Bill (E-way Bill) ID for the delivery"2621 },2622 "track_url": {2623 "type": [2624 "string",2625 "null"2626 ],2627 "description": "URL to track the delivery status or shipment details"2628 },2629 "gst_tag": {2630 "type": [2631 "string",2632 "null"2633 ],2634 "description": "GST tag of the shipment"2635 },2636 "extension_id": {2637 "type": [2638 "string",2639 "null"2640 ],2641 "description": "Unique Identifier of Courier partner Extension"2642 },2643 "scheme_id": {2644 "type": [2645 "string",2646 "null"2647 ],2648 "description": "Unique identifier of a Courier partner scheme"2649 },2650 "courier_partner_slug": {2651 "type": [2652 "string",2653 "null"2654 ],2655 "description": "Unique identifier containing extension_id and scheme_id"2656 }2657 },2658 "required": [2659 "id",2660 "name",2661 "awb_no",2662 "eway_bill_id",2663 "track_url",2664 "gst_tag",2665 "extension_id",2666 "scheme_id",2667 "courier_partner_slug"2668 ]2669 },2670 "rto_address": {2671 "type": "object",2672 "description": "The address to which shipment should be delivered in case of RTO",2673 "properties": {2674 "company_id": {2675 "type": "number",2676 "description": "ID of the company fulfilling the shipment"2677 },2678 "id": {2679 "type": "number",2680 "description": "ID of the store where RTO should happen"2681 },2682 "name": {2683 "type": "string",2684 "description": "A string representing the store's name"2685 },2686 "store_address_json": {2687 "type": "object",2688 "description": "Store address details",2689 "properties": {2690 "version": {2691 "type": "string",2692 "description": "Address version, to be deprecated"2693 },2694 "contact_person": {2695 "type": "string",2696 "description": "Name of the contact person associated with the address"2697 },2698 "address": {2699 "type": "string",2700 "description": "\"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""2701 },2702 "address1": {2703 "type": "string",2704 "description": "\"A string representing the first line of the address, typically containing street or building information\""2705 },2706 "address2": {2707 "type": "string",2708 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""2709 },2710 "name": {2711 "type": "string",2712 "description": "A string representing the store's name"2713 },2714 "area": {2715 "type": "string",2716 "description": "A string specifying the locality or area associated with the address"2717 },2718 "area_code": {2719 "type": "string",2720 "x-not-enum": true,2721 "description": "Area code of the address"2722 },2723 "area_code_slug": {2724 "type": "string",2725 "description": "Unique identifier or slug for the area code associated with the address"2726 },2727 "landmark": {2728 "type": "string",2729 "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""2730 },2731 "city": {2732 "type": "string",2733 "description": "A string denoting the city or municipality of the address"2734 },2735 "state": {2736 "type": "string",2737 "description": "A string indicating the state or province of the address"2738 },2739 "country": {2740 "type": "string",2741 "description": "A string indicating the country of the address"2742 },2743 "pincode": {2744 "type": "string",2745 "description": "A string indicating the postal code or PIN code of the address area"2746 },2747 "longitude": {2748 "type": [2749 "number",2750 "string"2751 ],2752 "description": "The longitude of the address"2753 },2754 "sector": {2755 "type": "string",2756 "description": "A string specifying the sector or district of the address if applicable"2757 },2758 "latitude": {2759 "type": [2760 "number",2761 "string"2762 ],2763 "description": "The latitude of the address"2764 },2765 "phone": {2766 "type": "string",2767 "description": "Mobile phone number of recipient associated with the address"2768 },2769 "email": {2770 "type": "string",2771 "description": "Email of the recipient associated with the address"2772 },2773 "address_type": {2774 "type": "string",2775 "x-not-enum": true,2776 "description": "Type of address (e.g., home, office, registered)"2777 },2778 "address_category": {2779 "type": "string",2780 "x-not-enum": true,2781 "description": "Category or classification of the address"2782 },2783 "created_at": {2784 "type": "string",2785 "format": "date-time",2786 "description": "Date and time when the address was created"2787 },2788 "updated_at": {2789 "type": "string",2790 "format": "date-time",2791 "description": "Date and time when the address was last updated"2792 },2793 "country_phone_code": {2794 "type": [2795 "string",2796 "null"2797 ],2798 "x-not-enum": true,2799 "description": "Phone code for the country of the address"2800 },2801 "country_iso_code": {2802 "type": "string",2803 "x-not-enum": true,2804 "description": "ISO code representing the country of the address"2805 },2806 "country_code": {2807 "type": "string",2808 "x-not-enum": true,2809 "description": "ISO code representing the country of the address"2810 },2811 "display_address": {2812 "type": "string",2813 "description": "Formatted display version of the address"2814 }2815 }2816 },2817 "code": {2818 "type": "string",2819 "description": "Alphanumeric code representing the store"2820 },2821 "location_type": {2822 "type": "string",2823 "x-not-enum": true,2824 "description": "Type of location e.g., warehouse, high_street"2825 },2826 "address1": {2827 "type": "string",2828 "description": "\"A string representing the first line of the address, typically containing street or building information\""2829 },2830 "address2": {2831 "type": "string",2832 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""2833 },2834 "display_address": {2835 "type": "string",2836 "description": "Formatted display version of the address"2837 },2838 "city": {2839 "type": "string",2840 "description": "A string denoting the city or municipality of the address"2841 },2842 "state": {2843 "type": "string",2844 "description": "A string indicating the state or province of the address"2845 },2846 "sector": {2847 "type": "string",2848 "description": "A string specifying the sector or district of the address if applicable"2849 },2850 "country": {2851 "type": "string",2852 "description": "A string indicating the country of the address"2853 },2854 "pincode": {2855 "type": "string",2856 "description": "A string indicating the postal code or PIN code of the address area"2857 },2858 "store_email": {2859 "type": "string",2860 "description": "Email of the recipient associated with the store"2861 },2862 "contact_person": {2863 "type": "string",2864 "description": "Name of the contact person associated with the address"2865 },2866 "phone": {2867 "type": "string",2868 "description": "Mobile phone number of recipient associated with the address"2869 }2870 },2871 "required": [2872 "company_id",2873 "id",2874 "name",2875 "store_address_json",2876 "code",2877 "location_type",2878 "address1",2879 "address2",2880 "display_address",2881 "city",2882 "state",2883 "sector",2884 "country",2885 "pincode",2886 "store_email",2887 "contact_person",2888 "phone"2889 ]2890 },2891 "weight": {2892 "type": "object",2893 "description": "Weight details for item/article",2894 "properties": {2895 "value": {2896 "type": "number"2897 },2898 "unit": {2899 "type": "string"2900 }2901 },2902 "required": [2903 "value",2904 "unit"2905 ]2906 },2907 "shipment_gst": {2908 "type": "object",2909 "description": "GST details associated with the shipment",2910 "properties": {2911 "value_of_good": {2912 "type": "number",2913 "description": "Effective selling price - Product GST Amount"2914 },2915 "gst_fee": {2916 "type": "number",2917 "description": "The fee associated with Goods and Services Tax (GST) for a product or service"2918 },2919 "brand_calculated_amount": {2920 "type": "number",2921 "description": "Effective selling price - Brand's additional discounts"2922 },2923 "tax_collected_at_source": {2924 "type": "number",2925 "description": "The tax amount collected at the source of income or transaction"2926 },2927 "gstin_code": {2928 "type": [2929 "string",2930 "null"2931 ],2932 "x-not-enum": true,2933 "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"2934 }2935 },2936 "required": [2937 "value_of_good",2938 "gst_fee",2939 "brand_calculated_amount",2940 "tax_collected_at_source",2941 "gstin_code"2942 ]2943 },2944 "store_invoice_id": {2945 "type": [2946 "string",2947 "null"2948 ],2949 "description": "Invoice ID attached to the shipment"2950 },2951 "credit_note_id": {2952 "type": [2953 "string",2954 "null"2955 ],2956 "description": "Credit Note ID attached to the shipment"2957 },2958 "order_created": {2959 "type": "string",2960 "description": "Order creation timestamp"2961 },2962 "payment_methods": {2963 "type": "object",2964 "description": "\"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details.\""2965 },2966 "payment_info": {2967 "type": "array",2968 "description": "\"Array of object containing payment methods used for placing an order.\"",2969 "items": {}2970 },2971 "order": {2972 "type": "object",2973 "description": "Order level details",2974 "properties": {2975 "ordering_channel": {2976 "type": "string",2977 "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."2978 },2979 "ordering_source": {2980 "type": "string",2981 "nullable": true,2982 "description": "To uniquely identify the source through which order has been placed."2983 },2984 "affiliate_order_date": {2985 "type": [2986 "string",2987 "null"2988 ],2989 "format": "date-time",2990 "description": "Order creation timestamp at application/extension end"2991 },2992 "affiliate_order_id": {2993 "type": "string",2994 "description": "Identifier of the order assigned by the application"2995 },2996 "fynd_order_id": {2997 "type": "string",2998 "description": "System generated unique identifier of the order"2999 },3000 "mode_of_payment": {3001 "type": "string",3002 "description": "Unique identifier associated with the payment mode"3003 },3004 "source": {3005 "type": "string",3006 "description": "Ordering source eg. affiliate, fynd"3007 },3008 "total_order_value": {3009 "type": "number",3010 "description": "Total order value"3011 },3012 "collect_by": {3013 "type": "string",3014 "description": "Whomsoever collected the money"3015 },3016 "refund_by": {3017 "type": "string",3018 "description": "Whomsoever will refund the money"3019 },3020 "order_value": {3021 "type": "number",3022 "description": "Value of the order"3023 },3024 "loyalty_discount_details": {3025 "type": "object",3026 "properties": {3027 "discount": {3028 "type": "number",3029 "description": "Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed"3030 },3031 "ownership": {3032 "type": "string",3033 "description": "Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace"3034 },3035 "is_applied": {3036 "type": "boolean",3037 "description": "Specifies whether the loyalty discount has been applied to the order"3038 }3039 },3040 "description": "Applied loyalty discount information"3041 }3042 },3043 "required": [3044 "ordering_channel",3045 "affiliate_order_date",3046 "affiliate_order_id",3047 "fynd_order_id",3048 "mode_of_payment",3049 "source",3050 "total_order_value",3051 "collect_by",3052 "refund_by",3053 "order_value"3054 ]3055 },3056 "order_source": {3057 "type": "string",3058 "description": "Ordering source eg. affiliate, fynd"3059 },3060 "journey_type": {3061 "type": [3062 "string",3063 "null"3064 ],3065 "description": "Journey type forward or return"3066 },3067 "einvoice_info": {3068 "type": "object",3069 "description": "Einvoice info if e-invoice is applicable",3070 "properties": {3071 "credit_note": {3072 "description": "Details of the reverse credit note einvoice",3073 "type": "object",3074 "properties": {3075 "ack_dt": {3076 "type": "string",3077 "description": "Date and time when the e-invoice acknowledgment was received"3078 },3079 "ack_no": {3080 "type": "string",3081 "description": "Acknowledgment number assigned to the e-invoice upon successful submission"3082 },3083 "irn": {3084 "type": "string",3085 "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"3086 },3087 "signed_invoice": {3088 "type": "string",3089 "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"3090 },3091 "signed_qr_code": {3092 "x-not-enum": true,3093 "type": "string",3094 "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"3095 },3096 "message": {3097 "type": "array",3098 "description": "Error Message received from JioGSt",3099 "items": {3100 "type": "object",3101 "properties": {3102 "ErrorCode": {3103 "type": [3104 "string",3105 "null"3106 ]3107 },3108 "ErrorMessage": {3109 "type": [3110 "string",3111 "null"3112 ]3113 }3114 }3115 }3116 }3117 }3118 },3119 "invoice": {3120 "description": "Details of the forward invoice einvoice",3121 "type": "object",3122 "properties": {3123 "ack_dt": {3124 "type": "string",3125 "description": "Date and time when the e-invoice acknowledgment was received"3126 },3127 "ack_no": {3128 "type": "string",3129 "description": "Acknowledgment number assigned to the e-invoice upon successful submission"3130 },3131 "irn": {3132 "type": "string",3133 "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"3134 },3135 "signed_invoice": {3136 "type": "string",3137 "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"3138 },3139 "signed_qr_code": {3140 "x-not-enum": true,3141 "type": "string",3142 "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"3143 },3144 "message": {3145 "type": "array",3146 "description": "Error Message received from JioGSt",3147 "items": {3148 "type": "object",3149 "properties": {3150 "ErrorCode": {3151 "type": [3152 "string",3153 "null"3154 ]3155 },3156 "ErrorMessage": {3157 "type": [3158 "string",3159 "null"3160 ]3161 }3162 }3163 }3164 }3165 }3166 }3167 },3168 "required": []3169 },3170 "lock_status": {3171 "type": "boolean",3172 "description": "Lock status of the shipment"3173 },3174 "original_bag_list": {3175 "type": "array",3176 "items": {3177 "type": "number"3178 },3179 "description": "List of Bag ids when the order was created"3180 },3181 "shipment_update_time": {3182 "type": "number",3183 "description": "Last shipment update time"3184 },3185 "previous_shipment_id": {3186 "type": [3187 "string",3188 "null"3189 ],3190 "description": "\"ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition\""3191 },3192 "fyndstore_emp": {3193 "type": "object",3194 "description": "Fynd store employee details",3195 "properties": {},3196 "required": []3197 },3198 "ordering_store": {3199 "description": "Store details from which order was placed in case of StoreOS",3200 "required": [],3201 "type": "object",3202 "properties": {3203 "id": {3204 "type": "number",3205 "description": "Unique identifier for the store."3206 },3207 "code": {3208 "type": "string",3209 "description": "Alphanumeric code representing the store."3210 },3211 "name": {3212 "type": "string",3213 "description": "Name of the store."3214 },3215 "address": {3216 "type": "string",3217 "description": "Physical address of the store."3218 },3219 "state": {3220 "type": "string",3221 "description": "State where the store is located."3222 },3223 "city": {3224 "type": "string",3225 "description": "City where the store is located."3226 },3227 "pincode": {3228 "type": "string",3229 "description": "Postal code (pincode) of the store's location."3230 },3231 "country": {3232 "type": "string",3233 "description": "Country where the store is situated."3234 },3235 "phone": {3236 "type": "string",3237 "description": "Contact phone number for the store."3238 },3239 "fulfillment_channel": {3240 "type": "string",3241 "description": "Type of fulfillment channel used by the store."3242 },3243 "location_type": {3244 "type": "string",3245 "enum": [3246 "high_street",3247 "mall",3248 "store",3249 "warehouse"3250 ],3251 "description": "Type of location e.g., warehouse, high_street"3252 },3253 "company_id": {3254 "type": "number",3255 "description": "Identifier of the company responsible for fulfilling shipments from this store"3256 },3257 "is_active": {3258 "type": "boolean",3259 "description": "Boolean indicating whether the store is currently active"3260 },3261 "tags": {3262 "type": "array",3263 "items": {3264 "type": "string"3265 },3266 "description": "Array of tags associated with the store"3267 }3268 }3269 },3270 "coupon": {3271 "type": "object",3272 "description": "Coupon related details",3273 "properties": {},3274 "required": []3275 },3276 "cart_info": {3277 "type": "object",3278 "description": "Cart related information",3279 "properties": {3280 "cart_id": {3281 "type": "string",3282 "description": "The unique identifier of the cart"3283 },3284 "cart_uid": {3285 "type": "number",3286 "description": "UID associated with the cart"3287 }3288 },3289 "required": [3290 "cart_id",3291 "cart_uid"3292 ]3293 }3294 },3295 "required": [3296 "status",3297 "shipment_status",3298 "application_id",3299 "shipment_id",3300 "company_id",3301 "app_company_id",3302 "order_id",3303 "merchant_id",3304 "user",3305 "delivery_address",3306 "billing_address",3307 "delivery_partner_details",3308 "bags",3309 "bag_status_history",3310 "fulfilling_store",3311 "prices",3312 "payments",3313 "affiliate_details",3314 "dp_details",3315 "rto_address",3316 "weight",3317 "shipment_gst",3318 "store_invoice_id",3319 "credit_note_id",3320 "order_created",3321 "payment_methods",3322 "payment_info",3323 "order",3324 "order_source",3325 "journey_type",3326 "einvoice_info",3327 "lock_status",3328 "original_bag_list",3329 "shipment_update_time",3330 "previous_shipment_id",3331 "fyndstore_emp",3332 "ordering_store",3333 "coupon",3334 "cart_info"3335 ]3336 }3337 },3338 "required": [3339 "shipment"3340 ]3341 }3342 }3343}
Payload Example
1{2 "event": {3 "trace_id": [4 "0000000000000000cd20af0b03839b95"5 ],6 "name": "shipment",7 "type": "update",8 "version": "1",9 "created_timestamp": 1711716048137,10 "id": "DZlcvyBgMu/zX1n9knpNNfl7lVPsG/Pgqbpyjt+SbhU=",11 "category": "application"12 },13 "company_id": 2411,14 "application_id": "618a224ce93512680cfd93d0",15 "contains": [16 "shipment"17 ],18 "payload": {19 "shipment": {20 "status": "ready_for_dp_assignment",21 "shipment_status": {22 "status": "ready_for_dp_assignment",23 "created_ts": "2024-03-29T12:40:47Z",24 "meta": {25 "request_meta": {},26 "estimated_sla_ts": "2024-03-31T10:30:00Z",27 "estimated_sla_time": "2024-03-31T16:00:00",28 "state_manager_used": "entity"29 },30 "updated_ts": "2024-03-29T12:40:47Z",31 "id": 163729667,32 "created_at": "2024-03-29T18:10:48+00:00",33 "shipment_id": "17116842623541524113",34 "bag_list": [35 "33814027"36 ],37 "current_shipment_status": "ready_for_dp_assignment",38 "status_created_at": "2024-03-29T18:10:48+00:00"39 },40 "application_id": "618a224ce93512680cfd93d0",41 "shipment_id": "17116842623541524113",42 "company_id": 2411,43 "app_company_id": 2411,44 "order_id": "FYMP66063AA601BFA6A8",45 "merchant_id": "",46 "user": {47 "mongo_user_id": null,48 "mobile": "1111111111",49 "external_customer_id": null,50 "email": "test@example.com",51 "gender": null,52 "meta": {53 "country_phone_code": ""54 },55 "id": 17831651,56 "user_oid": null,57 "first_name": "test test",58 "last_name": "",59 "country_phone_code": "",60 "is_anonymous_user": false61 },62 "delivery_address": {63 "area": "Delhi",64 "city": "New Delhi",65 "name": "test test ",66 "email": "test@example.com",67 "phone": "1111111111",68 "state": "Delhi",69 "mobile": "1111111111",70 "address": "test address",71 "country": "India",72 "pincode": "110058",73 "user_id": 17831651,74 "version": "1.0",75 "address1": "test address",76 "address2": "",77 "landmark": "",78 "latitude": 0,79 "area_code": "",80 "longitude": 0,81 "created_at": "2024-03-29T09:21:02+00:00",82 "first_name": "test test ",83 "state_code": "DL",84 "updated_at": "2024-03-29T09:21:02+00:00",85 "address_type": "home",86 "geo_location": {},87 "area_code_slug": "",88 "contact_person": "test test ",89 "display_address": "test address",90 "address_category": "",91 "country_iso_code": "IN",92 "country_phone_code": null93 },94 "billing_address": {95 "area": "Delhi",96 "city": "New Delhi",97 "name": "",98 "email": "test@example.com",99 "phone": "1111111111",100 "state": "Delhi",101 "mobile": "1111111111",102 "address": "test address",103 "country": "India",104 "pincode": "110058",105 "version": "1.0",106 "address1": "test address",107 "address2": "",108 "landmark": "",109 "latitude": 0,110 "area_code": "",111 "longitude": 0,112 "created_at": "2024-03-29 09:21:02",113 "first_name": "test user ",114 "state_code": "DL",115 "updated_at": "2024-03-29 09:21:02",116 "address_type": "home",117 "geo_location": {},118 "area_code_slug": "",119 "contact_person": "test user ",120 "display_address": "test address",121 "address_category": "",122 "country_iso_code": "IN",123 "country_phone_code": null124 },125 "delivery_partner_details": {126 "id": null,127 "name": null,128 "awb_no": null,129 "eway_bill_id": null,130 "track_url": null,131 "gst_tag": "sgst",132 "extension_id": null,133 "scheme_id": null,134 "courier_partner_slug": null135 },136 "bags": [137 {138 "financial_breakup": [139 {140 "brand_calculated_amount": 399,141 "discount": 600,142 "gst_fee": 19,143 "gst_tax_percentage": 5,144 "gst_tag": "IGST",145 "hsn_code": "61099010",146 "identifiers": {147 "sku_code": "LTSH00038_B.GREEN_XL"148 },149 "price_marked": 999,150 "tax_collected_at_source": 0,151 "tcs_percentage": 0,152 "total_units": 1,153 "value_of_good": 380,154 "item_name": "Cantabil Ladies T-Shirt",155 "size": "XL/CH 1.01M"156 }157 ],158 "entity_type": "bag",159 "item": {160 "can_return": true,161 "l3_category_name": "Others level 3",162 "l3_category": 436,163 "l2_category": [164 "Others level 2"165 ],166 "l2_category_id": 412,167 "l1_category": [168 "Others"169 ],170 "color": null,171 "id": 8747251,172 "branch_url": null,173 "code": "LTSH00038_B.GREEN",174 "last_updated_at": "2024-03-29T09:21:02+00:00",175 "webstore_product_url": null,176 "l1_category_id": 406,177 "gender": null,178 "brand_id": 75,179 "slug_key": "cantabil-ladies-t-shirt-aqyvd9-7lhu-8747251",180 "name": "Cantabil Ladies T-Shirt",181 "brand": "CANTABIL",182 "can_cancel": true,183 "meta": {184 "tags": [],185 "departments": [186 8187 ]188 },189 "attributes": {190 "name": "Cantabil Ladies T-Shirt",191 "color": "B.Green",192 "essential": "No",193 "brand_name": "CANTABIL",194 "primary_color": "Green",195 "primary_color_hex": "2BD892",196 "primary-colour-hex-code": "2BD892",197 "media": []198 },199 "department_id": 8,200 "size": "XL/CH 1.01M",201 "image": [202 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/eVQ_yGxE69-LTSH00038_BGREEN-(1).jpg",203 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/3lbWgByqlM-LTSH00038_BGREEN-(2).jpg",204 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/fXYIC_EmtC-LTSH00038_BGREEN-(3).jpg",205 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/G99OlYAKm-LTSH00038_BGREEN-(4).jpg",206 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/hDQ9zVPYdx-LTSH00038_BGREEN-(5).jpg",207 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/cXpjMVFRff-LTSH00038_BGREEN-(6).jpg",208 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/wbx4WiepTi-LTSH00038_BGREEN-(7).jpg"209 ]210 },211 "brand": {212 "brand_name": "CANTABIL",213 "modified_on": "2023-06-20T18:49:47+00:00",214 "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/media/logo/brand/original/848_4a2906acec4c4339b31661825292c8eb.jpg",215 "id": 75,216 "created_on": "2016-01-04T05:15:13+00:00",217 "is_virtual_invoice": false,218 "credit_note_allowed": false219 },220 "bag_id": 33814027,221 "article": {222 "identifiers": {223 "sku_code": "LTSH00038_B.GREEN_XL"224 },225 "esp_modified": "",226 "size": "XL/CH 1.01M",227 "code": "",228 "raw_meta": null,229 "set": {},230 "is_set": "",231 "seller_identifier": "LTSH00038_B.GREEN_XL",232 "return_config": {233 "time": 7,234 "unit": "days",235 "returnable": true236 },237 "_id": "65ee342bbc93d4f9b3c1be8d",238 "uid": "65ee342bbc93d4f9b3c1be8d",239 "child_details": {},240 "dimensions": {},241 "weight": {},242 "currency": {},243 "expiration_date": null244 },245 "current_operational_status": {246 "status": "ready_for_dp_assignment",247 "created_ts": "2024-03-29T12:40:47Z",248 "delivery_partner_id": null,249 "kafka_sync": false,250 "bag_id": 33814027,251 "store_id": 21209,252 "updated_ts": "2024-03-29T12:40:47Z",253 "id": 216538704,254 "created_at": "2024-03-29T18:10:48+00:00",255 "state_id": 113,256 "state_type": "operational",257 "shipment_id": "17116842623541524113",258 "delivery_awb_number": null,259 "updated_at": "2024-03-29T18:10:48+00:00",260 "bag_state_mapper": {261 "journey_type": "forward",262 "app_display_name": "Ready For Dp Assignment",263 "state_type": "operational",264 "app_state_name": "ready_for_dp_assignment",265 "name": "ready_for_dp_assignment",266 "app_facing": false,267 "id": 113,268 "display_name": "Ready For Dp Assignment",269 "notify_customer": false,270 "is_active": true271 },272 "reasons": [],273 "action_user": {}274 },275 "affiliate_bag_details": {276 "affiliate_bag_id": "111111",277 "affiliate_order_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",278 "affiliate_meta": {279 "fynd": {280 "fulfilment_identifier": "pulse",281 "fulfilment_identifiers_list": [282 "pulse"283 ]284 },285 "channel_shipment_id": null,286 "channel_order_id": null,287 "due_date": null,288 "is_priority": false,289 "box_type": null,290 "coupon_code": null,291 "affiliate_sku": "LTSH00038_B.GREEN_XL",292 "is_serial_number_required": true,293 "size_level_total_qty": null,294 "loyalty_discount": 0,295 "employee_discount": 0296 },297 "loyalty_discount": 0,298 "employee_discount": 0299 },300 "payment_methods": {301 "PP": {302 "amount": 399303 }304 },305 "quantity": 1,306 "prices": {307 "price_effective": 399,308 "discount": 600,309 "amount_paid": 399,310 "coupon_effective_discount": 0,311 "delivery_charge": 0,312 "fynd_credits": 0,313 "cod_charges": 0,314 "refund_credit": 0,315 "cashback": 0,316 "refund_amount": 399,317 "added_to_fynd_cash": false,318 "cashback_applied": 0,319 "gst_tax_percentage": 5,320 "value_of_good": 380,321 "price_marked": 999,322 "transfer_price": 0,323 "brand_calculated_amount": 399,324 "tax_collected_at_source": 0,325 "tcs_percentage": 0,326 "promotion_effective_discount": 0,327 "gift_price": 0,328 "coupon_value": 0,329 "seller_promotion_effective_discount": 0,330 "fynd_promotion_effective_discount": 0,331 "amount_paid_roundoff": 399332 },333 "order_created": "2024-03-29T09:21:02+00:00",334 "gst_details": {335 "gstin_code": "09AAACK3901B1Z4",336 "gst_tag": "IGST",337 "hsn_code": "61099010",338 "value_of_good": 380,339 "gst_tax_percentage": 5,340 "is_default_hsn_code": false,341 "brand_calculated_amount": 399,342 "tax_collected_at_source": 0,343 "hsn_code_id": "627783855e4c6fdbc8be3f70",344 "gst_fee": 19,345 "igst_tax_percentage": 5,346 "sgst_tax_percentage": 0,347 "cgst_tax_percentage": 0,348 "igst_gst_fee": 19,349 "cgst_gst_fee": "0",350 "sgst_gst_fee": "0",351 "tax_rule_id": "627783925e4c6fdbc8be40c7"352 },353 "line_number": 1,354 "applied_promos": [],355 "taxes": [356 {357 "name": "GST",358 "rate": 0.09,359 "taxable_amount": 231.19,360 "tax_amount": 20.81361 }362 ],363 "meta": {364 "charges": [365 {366 "name": "amount_paid",367 "type": "amount_paid",368 "amount": {369 "value": 399,370 "currency": "INR"371 }372 },373 {374 "name": "price_effective",375 "type": "price_effective",376 "amount": {377 "value": 399,378 "currency": "INR"379 }380 },381 {382 "name": "price_marked",383 "type": "price_marked",384 "amount": {385 "value": 999,386 "currency": "INR"387 }388 },389 {390 "name": "mrp",391 "type": "mrp",392 "amount": {393 "value": 999,394 "currency": "INR"395 }396 },397 {398 "name": "unit_price",399 "type": "unit_price",400 "amount": {401 "value": 399,402 "currency": "INR"403 }404 },405 {406 "name": "delivery_charge",407 "type": "delivery_charge",408 "amount": {409 "value": 0,410 "currency": "INR"411 }412 },413 {414 "name": "discount",415 "type": "discount",416 "amount": {417 "value": 600,418 "currency": "INR"419 }420 }421 ],422 "group_id": "",423 "gift_card": {},424 "tag_number": [425 "MP29513922"426 ],427 "docket_number": "171168426235415241131",428 "affiliate_meta": {429 "affiliate_sku": "LTSH00038_B.GREEN_XL",430 "is_serial_number_required": true431 },432 "partial_can_ret": false,433 "parent_docket_number": "171168426235415241131",434 "delivery_charges_hsn_code": "996819",435 "multi_quantity_bag_enabled": false436 }437 }438 ],439 "bag_status_history": [440 {441 "status": "pending",442 "created_ts": "2024-03-29T03:51:02Z",443 "delivery_partner_id": null,444 "kafka_sync": false,445 "bag_id": 33814027,446 "store_id": 21209,447 "updated_ts": "2024-03-29T03:51:02Z",448 "id": 216405514,449 "created_at": "2024-03-29T09:21:02+00:00",450 "state_id": 89,451 "state_type": "operational",452 "shipment_id": "17116842623541524113",453 "delivery_awb_number": null,454 "updated_at": "2024-03-29T09:21:02+00:00",455 "bag_state_mapper": {456 "journey_type": "forward",457 "app_display_name": "Pending",458 "state_type": "operational",459 "app_state_name": "pending",460 "name": "pending",461 "app_facing": true,462 "id": 89,463 "display_name": "Pending",464 "notify_customer": true,465 "is_active": true466 },467 "reasons": [],468 "action_user": {}469 },470 {471 "status": "placed",472 "created_ts": "2024-03-29T03:51:02Z",473 "delivery_partner_id": null,474 "kafka_sync": false,475 "bag_id": 33814027,476 "store_id": 21209,477 "updated_ts": "2024-03-29T03:51:02Z",478 "id": 216405515,479 "created_at": "2024-03-29T09:21:03+00:00",480 "state_id": 1,481 "state_type": "operational",482 "shipment_id": "17116842623541524113",483 "delivery_awb_number": null,484 "updated_at": "2024-03-29T09:21:03+00:00",485 "bag_state_mapper": {486 "journey_type": "forward",487 "app_display_name": "Processing",488 "state_type": "operational",489 "app_state_name": "processing",490 "name": "placed",491 "app_facing": true,492 "id": 1,493 "display_name": "Placed",494 "notify_customer": true,495 "is_active": true496 },497 "reasons": [],498 "action_user": {}499 },500 {501 "status": "bag_confirmed",502 "created_ts": "2024-03-29T12:30:59Z",503 "delivery_partner_id": null,504 "kafka_sync": false,505 "bag_id": 33814027,506 "store_id": 21209,507 "updated_ts": "2024-03-29T12:30:59Z",508 "id": 216536772,509 "created_at": "2024-03-29T18:01:00+00:00",510 "state_id": 2,511 "state_type": "operational",512 "shipment_id": "17116842623541524113",513 "delivery_awb_number": null,514 "updated_at": "2024-03-29T18:01:00+00:00",515 "bag_state_mapper": {516 "journey_type": "forward",517 "app_display_name": "Confirmed",518 "state_type": "operational",519 "app_state_name": "confirmed",520 "name": "bag_confirmed",521 "app_facing": true,522 "id": 2,523 "display_name": "Confirmed",524 "notify_customer": false,525 "is_active": true526 },527 "reasons": [],528 "action_user": {}529 },530 {531 "status": "bag_invoiced",532 "created_ts": "2024-03-29T12:40:47Z",533 "delivery_partner_id": null,534 "kafka_sync": false,535 "bag_id": 33814027,536 "store_id": 21209,537 "updated_ts": "2024-03-29T12:40:47Z",538 "id": 216538701,539 "created_at": "2024-03-29T18:10:48+00:00",540 "state_id": 91,541 "state_type": "operational",542 "shipment_id": "17116842623541524113",543 "delivery_awb_number": null,544 "updated_at": "2024-03-29T18:10:48+00:00",545 "bag_state_mapper": {546 "journey_type": "forward",547 "app_display_name": "Bag Invoiced",548 "state_type": "operational",549 "app_state_name": "bag_invoiced",550 "name": "bag_invoiced",551 "app_facing": false,552 "id": 91,553 "display_name": "Bag Invoiced",554 "notify_customer": false,555 "is_active": true556 },557 "reasons": [],558 "action_user": {559 "title": "Staff",560 "user_id": "23546902",561 "user_name": "65a113b057cb98b50c75f344",562 "order_role": "full_access",563 "employee_code": ""564 }565 },566 {567 "status": "ready_for_dp_assignment",568 "created_ts": "2024-03-29T12:40:47Z",569 "delivery_partner_id": null,570 "kafka_sync": false,571 "bag_id": 33814027,572 "store_id": 21209,573 "updated_ts": "2024-03-29T12:40:47Z",574 "id": 216538704,575 "created_at": "2024-03-29T18:10:48+00:00",576 "state_id": 113,577 "state_type": "operational",578 "shipment_id": "17116842623541524113",579 "delivery_awb_number": null,580 "updated_at": "2024-03-29T18:10:48+00:00",581 "bag_state_mapper": {582 "journey_type": "forward",583 "app_display_name": "Ready For Dp Assignment",584 "state_type": "operational",585 "app_state_name": "ready_for_dp_assignment",586 "name": "ready_for_dp_assignment",587 "app_facing": false,588 "id": 113,589 "display_name": "Ready For Dp Assignment",590 "notify_customer": false,591 "is_active": true592 },593 "reasons": [],594 "action_user": {}595 }596 ],597 "fulfilling_store": {598 "id": 21209,599 "code": "V5",600 "name": "Cantabil Retail India Limited",601 "address": "test address",602 "state": "Uttar Pradesh",603 "city": "Lucknow",604 "pincode": "1111",605 "country": "India",606 "phone": "1111111111",607 "meta": {608 "timing": [609 {610 "weekday": "monday",611 "opening": {612 "hour": 11,613 "minute": 0614 },615 "closing": {616 "hour": 22,617 "minute": 0618 },619 "open": true620 },621 {622 "weekday": "tuesday",623 "opening": {624 "hour": 11,625 "minute": 0626 },627 "closing": {628 "hour": 22,629 "minute": 0630 },631 "open": true632 },633 {634 "weekday": "wednesday",635 "opening": {636 "hour": 11,637 "minute": 0638 },639 "closing": {640 "hour": 22,641 "minute": 0642 },643 "open": true644 },645 {646 "weekday": "thursday",647 "opening": {648 "hour": 11,649 "minute": 0650 },651 "closing": {652 "hour": 22,653 "minute": 0654 },655 "open": true656 },657 {658 "weekday": "friday",659 "opening": {660 "hour": 11,661 "minute": 0662 },663 "closing": {664 "hour": 22,665 "minute": 0666 },667 "open": true668 },669 {670 "weekday": "saturday",671 "opening": {672 "hour": 11,673 "minute": 0674 },675 "closing": {676 "hour": 22,677 "minute": 0678 },679 "open": true680 },681 {682 "weekday": "sunday",683 "opening": {684 "hour": 11,685 "minute": 0686 },687 "closing": {688 "hour": 22,689 "minute": 0690 },691 "open": true692 }693 ],694 "stage": null,695 "display_name": "Cantabil Retail India Limited",696 "notification_emails": [697 "test@example.com"698 ],699 "product_return_config": {700 "on_same_store": false,701 "store_uid": 14396702 },703 "gst_credentials": {704 "e_invoice": {705 "enabled": false706 },707 "e_waybill": {708 "enabled": false709 }710 },711 "gst_number": "111111",712 "additional_contact_details": {713 "number": [714 "91 - 111111",715 "91 - 111111"716 ]717 },718 "documents": {719 "gst": {720 "type": "gst",721 "value": "09AAACK3901B1Z4",722 "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/2411/stores/all/legal/documents/free/original/oAtgkjxi4-09-UP-Certificate.pdf",723 "verified": true,724 "legal_name": "Cantabil Retail India Limited"725 }726 },727 "auto_invoice": false,728 "credit_note": false,729 "ewaybill_portal_details": null730 },731 "fulfillment_channel": "pulse",732 "location_type": "high_street",733 "company_id": 2411,734 "is_active": false,735 "tags": []736 },737 "prices": {738 "amount_paid": 399,739 "refund_amount": 399,740 "price_marked": 999,741 "cod_charges": 0,742 "discount": 600,743 "cashback_applied": 0,744 "delivery_charge": 0,745 "fynd_credits": 0,746 "cashback": 0,747 "price_effective": 399,748 "refund_credit": 0,749 "value_of_good": 380,750 "coupon_value": 0,751 "tax_collected_at_source": 0,752 "promotion_effective_discount": 0,753 "fynd_promotion_effective_discount": 0,754 "seller_promotion_effective_discount": 0,755 "cn_refund_amount": 0,756 "gift_price": 0,757 "amount_paid_roundoff": 399758 },759 "payments": {760 "id": 8,761 "mode": "PP",762 "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payment/default_card.png",763 "display_name": "on",764 "display_priority": 7,765 "source": "PartnerPay",766 "is_active": false767 },768 "affiliate_details": {769 "id": "618a224ce93512680cfd93d0",770 "affiliate_bag_id": "1847041749",771 "affiliate_order_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",772 "company_affiliate_tag": "MYNTRA_IN",773 "affiliate_id": "618a224ce93512680cfd93d0",774 "affiliate_shipment_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",775 "shipment_meta": {776 "sla": null,777 "weight": 500,778 "due_date": "2024-03-31 16:00:00",779 "external": {},780 "vertical": "NA",781 "lock_data": {782 "mto": false,783 "locked": false,784 "lock_message": "Shipment locked as per application config"785 },786 "bag_weight": {787 "33814027": 500788 },789 "debug_info": {790 "stormbreaker_uuid": ""791 },792 "dp_options": {},793 "order_type": "HomeDelivery",794 "dp_sort_key": null,795 "is_self_ship": false,796 "delivery_slots": {},797 "courier_partners": [],798 "fulfillment_tags": [],799 "is_international": false,800 "processing_dates": {801 "pack_by_date": "31-03-2024 16:00:00",802 "confirm_by_date": "29-03-2024 09:20:57"803 },804 "is_export_shipment": false,805 "channel_shipment_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",806 "same_store_available": true,807 "fulfill_virtual_invoice": false,808 "618a224ce93512680cfd93d0": {809 "merchant_id": "AAASELEL",810 "payment_method": "PP",811 "x_partner_store": "myntra",812 "marketplace_store_id": "V5",813 "processing_start_time": "29-03-2024 09:20:57"814 },815 "fulfilment_priority_text": null,816 "store_invoice_updated_ts": "2024-03-29T12:40:47Z",817 "store_invoice_updated_date": "2024-03-29T18:10:47+00:00",818 "E-invoice_applicable_response": {819 "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",820 "is_applicable": false821 },822 "auto_trigger_dp_assignment_ACF": true,823 "eligible_for_split": false824 },825 "affiliate_meta": {826 "fynd": {827 "fulfilment_identifier": "pulse",828 "fulfilment_identifiers_list": [829 "pulse"830 ]831 },832 "channel_shipment_id": null,833 "channel_order_id": null,834 "due_date": null,835 "is_priority": false,836 "box_type": null,837 "coupon_code": null,838 "affiliate_sku": "LTSH00038_B.GREEN_XL",839 "is_serial_number_required": true,840 "size_level_total_qty": null,841 "loyalty_discount": 0,842 "employee_discount": 0843 },844 "affiliate_store_id": "V5",845 "pdf_links": {846 "label_type": "external",847 "invoice_type": "external"848 },849 "config": {850 "id": "618a224ce93512680cfd93d0",851 "meta": [852 {853 "name": "shipment_lock_states",854 "value": [855 "bag_confirmed",856 "dp_assigned"857 ]858 }859 ],860 "name": "MYNTRA_IN",861 "token": null,862 "dp_assignment": false,863 "app_company_id": 2411,864 "article_assignment": {},865 "force_reassignment": false,866 "sales_channel_logo": "",867 "ordering_channel_logo": "",868 "post_order_reassignment": false869 }870 },871 "article_details": {872 "status": {873 "ready_for_dp_assignment": {874 "65ee342bbc93d4f9b3c1be8d": {875 "uid": "65ee342bbc93d4f9b3c1be8d",876 "_id": "65ee342bbc93d4f9b3c1be8d",877 "is_set": "",878 "bag_ids": [879 {880 "bag_id": 33814027,881 "quantity": 1882 }883 ],884 "quantity": 1,885 "reasons": {}886 }887 }888 }889 },890 "dp_details": {891 "id": null,892 "name": null,893 "awb_no": null,894 "eway_bill_id": null,895 "track_url": null,896 "gst_tag": "sgst",897 "extension_id": null,898 "scheme_id": null,899 "courier_partner_slug": null900 },901 "rto_address": {902 "location_type": "warehouse",903 "name": "Cantabil Retail India Limited- B16",904 "store_address_json": {905 "version": "1.0",906 "contact_person": "Cantabil Retail",907 "address": "",908 "address1": "test address",909 "address2": "NEW DELHI",910 "name": "Cantabil Retail",911 "area": "",912 "area_code": "",913 "area_code_slug": "",914 "landmark": "",915 "city": "North West Delhi",916 "state": "Delhi",917 "country": "India",918 "pincode": "110035",919 "longitude": 72.8423802,920 "sector": "",921 "latitude": 19.0653252,922 "phone": "1111111111",923 "email": "test@example.com",924 "address_type": "store",925 "address_category": "store",926 "created_at": "2024-03-29 18:01:00",927 "updated_at": "2024-03-29 18:01:00",928 "country_phone_code": null,929 "country_iso_code": "IN",930 "country_code": "IN",931 "display_address": "test address"932 },933 "id": 14396,934 "code": "WHCIRL",935 "company_id": 2411,936 "address1": "test address",937 "address2": "NEW DELHI",938 "display_address": "test address",939 "city": "North West Delhi",940 "state": "Delhi",941 "sector": "",942 "country": "India",943 "pincode": "110035",944 "store_email": "test@example.com",945 "contact_person": "Cantabil Retail",946 "phone": "1111111111"947 },948 "weight": {949 "value": 500,950 "unit": "gram"951 },952 "shipment_meta": {953 "sla": null,954 "weight": 500,955 "due_date": "2024-03-31 16:00:00",956 "external": {},957 "vertical": "NA",958 "lock_data": {959 "mto": false,960 "locked": false,961 "lock_message": "Shipment locked as per application config"962 },963 "bag_weight": {964 "33814027": 500965 },966 "debug_info": {967 "stormbreaker_uuid": ""968 },969 "dp_options": {},970 "order_type": "HomeDelivery",971 "dp_sort_key": null,972 "is_self_ship": false,973 "delivery_slots": {},974 "courier_partners": [],975 "fulfillment_tags": [],976 "is_international": false,977 "processing_dates": {978 "pack_by_date": "31-03-2024 16:00:00",979 "confirm_by_date": "29-03-2024 09:20:57"980 },981 "is_export_shipment": false,982 "channel_shipment_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",983 "same_store_available": true,984 "fulfill_virtual_invoice": false,985 "618a224ce93512680cfd93d0": {986 "merchant_id": "AAASELEL",987 "payment_method": "PP",988 "x_partner_store": "myntra",989 "marketplace_store_id": "V5",990 "processing_start_time": "29-03-2024 09:20:57"991 },992 "fulfilment_priority_text": null,993 "store_invoice_updated_ts": "2024-03-29T12:40:47Z",994 "store_invoice_updated_date": "2024-03-29T18:10:47+00:00",995 "E-invoice_applicable_response": {996 "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",997 "is_applicable": false998 },999 "auto_trigger_dp_assignment_ACF": true,1000 "eligible_for_split": false1001 },1002 "shipment_gst": {1003 "value_of_good": 380,1004 "gst_fee": 19,1005 "brand_calculated_amount": 399,1006 "tax_collected_at_source": 0,1007 "gstin_code": "09AAACK3901B1Z4"1008 },1009 "store_invoice_id": "V50324-02266",1010 "credit_note_id": "",1011 "order_created": "2024-03-29T09:21:02+00:00",1012 "payment_methods": {1013 "PP": {1014 "amount": 399,1015 "mode": "PP",1016 "name": "on",1017 "collect_by": "seller",1018 "refund_by": "seller",1019 "meta": {1020 "payment_id": null1021 }1022 }1023 },1024 "payment_info": [],1025 "order": {1026 "ordering_channel": "MARKETPLACE",1027 "ordering_source": "marketplace",1028 "affiliate_order_date": "2024-03-29T09:21:02+00:00",1029 "affiliate_order_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",1030 "fynd_order_id": "FYMP66063AA601BFA6A8",1031 "mode_of_payment": "FY_MYNTRA",1032 "source": "NA",1033 "total_order_value": 399,1034 "collect_by": "seller",1035 "refund_by": "seller",1036 "order_value": 399,1037 "meta": {1038 "staff": {},1039 "charges": [1040 {1041 "name": "order",1042 "type": "amount_paid",1043 "amount": {1044 "value": 399,1045 "currency": "INR"1046 }1047 },1048 {1049 "name": "order",1050 "type": "order_value",1051 "amount": {1052 "value": 399,1053 "currency": "INR"1054 }1055 },1056 {1057 "code": "",1058 "name": "COD Charges",1059 "type": "cod_charges",1060 "amount": {1061 "value": 0,1062 "currency": "INR"1063 }1064 },1065 {1066 "code": "",1067 "name": "Delivery Charges",1068 "type": "delivery_charges",1069 "amount": {1070 "value": 0,1071 "currency": "INR"1072 }1073 }1074 ],1075 "currency": {1076 "currency_code": "INR",1077 "currency_name": "Indian Rupee",1078 "currency_symbol": "₹",1079 "currency_sub_unit": "Paisa"1080 },1081 "extra_meta": {},1082 "order_type": "NEW",1083 "employee_id": "",1084 "company_logo": null,1085 "payment_type": null,1086 "currency_info": {1087 "order_currency": "INR",1088 "conversion_rate": {}1089 },1090 "mongo_cart_id": 1000000007,1091 "ordering_store": null,1092 "seller_details": {},1093 "conversion_rate": {1094 "base": "INR",1095 "rates": {1096 "INR": {1097 "name": "Indian Rupee",1098 "value": 1,1099 "symbol": "₹",1100 "sub_unit": "Paisa"1101 }1102 },1103 "timestamp": 1710958051.7385451104 },1105 "sales_channel_logo": "",1106 "order_child_entities": [1107 "shipment",1108 "bag"1109 ],1110 "billing_staff_details": {},1111 "ordering_channel_logo": "",1112 "platform_user_details": {},1113 "external_creation_date": "29-03-2024 09:20:33",1114 "order_tags": []1115 }1116 },1117 "order_source": "NA",1118 "journey_type": "forward",1119 "einvoice_info": {},1120 "lock_status": false,1121 "original_bag_list": [1122 338140271123 ],1124 "shipment_update_time": 1711716047.9110363,1125 "transaction_meta": {},1126 "meta": {1127 "sla": null,1128 "weight": 500,1129 "due_date": "2024-03-31 16:00:00",1130 "external": {},1131 "vertical": "NA",1132 "lock_data": {1133 "mto": false,1134 "locked": false,1135 "lock_message": "Shipment locked as per application config"1136 },1137 "bag_weight": {1138 "33814027": 5001139 },1140 "debug_info": {1141 "stormbreaker_uuid": ""1142 },1143 "dp_options": {},1144 "order_type": "HomeDelivery",1145 "dp_sort_key": null,1146 "is_self_ship": false,1147 "delivery_slots": {},1148 "courier_partners": [],1149 "fulfillment_tags": [],1150 "is_international": false,1151 "processing_dates": {1152 "pack_by_date": "31-03-2024 16:00:00",1153 "confirm_by_date": "29-03-2024 09:20:57"1154 },1155 "is_export_shipment": false,1156 "channel_shipment_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",1157 "same_store_available": true,1158 "fulfill_virtual_invoice": false,1159 "618a224ce93512680cfd93d0": {1160 "merchant_id": "AAASELEL",1161 "payment_method": "PP",1162 "x_partner_store": "myntra",1163 "marketplace_store_id": "V5",1164 "processing_start_time": "29-03-2024 09:20:57"1165 },1166 "fulfilment_priority_text": null,1167 "store_invoice_updated_ts": "2024-03-29T12:40:47Z",1168 "store_invoice_updated_date": "2024-03-29T18:10:47+00:00",1169 "E-invoice_applicable_response": {1170 "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",1171 "is_applicable": false1172 },1173 "auto_trigger_dp_assignment_ACF": true,1174 "eligible_for_split": false1175 },1176 "previous_shipment_id": null,1177 "fyndstore_emp": {},1178 "ordering_store": {},1179 "coupon": {},1180 "cart_info": {1181 "cart_id": "",1182 "cart_uid": 10000000071183 }1184 }1185 }1186}
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
shipment
object
Required
Properties
status
string
Required
Webhook shipment status, i.e., either create or update
shipment_status
object
Required
Status of the shipment indicating its current stage
Properties
created_at
string
Required
Shipment status created timestamp
created_ts
string
Required
Shipment status created timestamp
id
number
Required
Unique identifier associated with the shipment's status object
updated_ts
string
Required
Shipment status updated timestamp
bag_list
array of string
Required
List of Bag ids transitioned in this shipment's status
shipment_id
string
Required
Unique shipment no. that is auto-generated
status
string
Required
Shipment's operational status
current_shipment_status
string
Required
Current shipment's status; it can be financial, logistics or operational
status_created_at
string
Required
application_id
string
Required
ID of the sales channel to which the shipment belongs
shipment_id
string
Required
Unique shipment no. that is auto-generated
company_id
number
Required
ID of the company fulfilling the shipment
app_company_id
number|null|string
Required
ID of the company from which order was placed
order_id
string
Required
Unique ID of order in which the shipment is present
merchant_id
string
Required
Unique merchant id
user
object
Required
Purchaser's details such as name, last name, mobile no. and email
Properties
email
string|null
Email address of the purchaser user
id
number|null
Unique identifier for the purchaser user within the system
gender
null|string
Gender of the purchaser user (e.g., male, female, other)
first_name
string
First name of the purchaser user
external_customer_id
string|null
External identifier associated with the purchaser user in another system
mobile
string|null
Mobile phone number of the purchaser user
last_name
string
Last name of the purchaser user
mongo_user_id
string|null
User's object ID in mongodb collection
user_oid
string|null
User Object ID assigned within the system
country_phone_code
string|null
Country phone code associated with the purchaser user's mobile number
is_anonymous_user
boolean
Flag indicating whether the user is anonymous
delivery_address
object
Required
Address where the shipment is to be delivered
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the recipient's name or the organization name associated with the address
email
string
Email of the recipient associated with the delivery address
phone
string
Mobile phone number of recipient associated with the delivery address
state
string
A string indicating the state or province of the delivery address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
user_id
number|null
Unique identifier for the fulfilling user within the system
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the recipient associated with the delivery address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the delivery address was created
first_name
string
First name of the recipient associated with the delivery address
updated_at
string
| date-time
Date and time when the delivery address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the delivery address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the delivery address
display_address
string
Formatted display version of the delivery address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
billing_address
object
Required
Address by which the invoice is created
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the billing user's name or the organization name associated with the address
email
string
Email address associated with the billing address user
phone
string
Phone number associated with the billing address user
state
string
A string indicating the state or province of the billing address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the individual associated with the billing address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the billing address was created
first_name
string
First name of the individual associated with the billing address
updated_at
string
| date-time
Date and time when the billing address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the billing address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the billing address
display_address
string
Formatted display version of the billing address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
delivery_partner_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
bags
array of object
Required
Details of all the products/articles in a shipment
Array of Properties
financial_breakup
array of object
Required
Financial breakup of an item
Array of Properties
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
discount
number
Required
The total amount discounted from the original MRP/actual price
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
identifiers
object
Required
Product identifiers
Properties
sku_code
string
SKU code of the product
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
total_units
number
Required
Total number of units of the item
value_of_good
number
Required
Effective selling price - Product GST Amount
item_name
string
Required
The name of the item being referenced
size
string
Required
The physical dimensions or specifications of the item, indicating its size or measurements
loyalty_discount
number
Amount reduced from the payable price when the customer applies loyalty program points while placing the order
entity_type
string
Required
Type of entity - bag, shipment
item
object
Required
Item details
Properties
l3_category_name
string
The name of the level 3 category to which the item belongs
l1_category_id
number
ID representing the level 2 category classification of the item
code
string
A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes
branch_url
null|string
Branch URL
l2_category
array of string
l3_category
number
ID representing the level 3 category classification of the item
last_updated_at
string
| date-time
Timestamp when the item was last updated
id
number
ID of the item that is being referred
name
string
The name of the item being referenced
can_return
boolean
Flag indicating if the item is eligible for return
webstore_product_url
null|string
Product URL
gender
null|string
Gender associated with an item
l2_category_id
number
ID representing the level 2 category classification of the item
color
null|string
Color associated with and item
slug_key
string
Automatically generated unique slug of the item
can_cancel
boolean
Flag indicating if the item is eligible for cancellation
attributes
object
An object containing descriptive properties of the item
Properties
name
string
The name or title of the item
color
string
The color description of the item
essential
string
Indicates whether the item is considered essential
brand_name
string
The brand name of the item
primary_color
string
The primary color of the item
primary_color_hex
string
The hexadecimal code representing the primary color
primary-colour-hex-code
string
The hexadecimal code representing the primary color
media
array of object
An array containing media files associated with the item
brand_id
number
The unique identifier associated with the brand of the item
brand
string
The brand or manufacturer of the item
l1_category
array of string
department_id
number
The unique identifier representing the department or category to which the item belongs
size
string
The size or dimensions of the item
image
array of string
brand
object
Required
Brand's information
Properties
credit_note_allowed
boolean
Required
If a credit note ID needs to be generated by the system
created_on
string
Required
Date and time when the brand was registered or created
id
number
Required
Unique identifier assigned to the brand for reference and identification
logo
string
Required
Visual representation or emblem associated with the brand
modified_on
string
Required
Date and time of the most recent update or modification to the brand's information
is_virtual_invoice
boolean
Required
If invoice ID needs to be generated by the system
brand_name
string
Required
Name or title of the brand used for identification and representation
bag_id
number
Required
The unique identifier associated with the bag
article
object
Required
Details of the article
Properties
identifiers
object
Required
Product identifiers
Properties
sku_code
string
esp_modified
string|boolean
Required
Flag representing if effective selling price has been modified
size
string
Required
The physical dimensions or specifications of the article, indicating its size or measurements
code
string
Required
A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes
set
object
Required
Details of the set article containing size distribution
Properties
quantity
integer
Number of units present
size_distribution
object
Object indicating the distribution of size and quantity of a set article
Properties
sizes
array of object
Array indicating size wise units present in a set article
Array of Properties
pieces
integer
Number of units of a particular size
size
string
Size of the article
is_set
string|boolean
Required
A boolean indicating whether the article is a set
seller_identifier
string
Required
Seller's identifier of the article
return_config
object
Required
Return configuration details of the article
Properties
time
number
Required
Number indicating number of hours or days
unit
string
Required
String indicating the unit of the time, eg. days, hours
returnable
boolean
Required
Flag indicating whether product is returnable or not
_id
string
Required
DB generated ID of the article
uid
string
Required
UID of the article
child_details
object|array
Required
Child article details if any
bundle_details
object
Contains bundle-related metadata for the shipment.
Properties
bundle_group_id
string
Unique group identifier for the bundle.
name
string
Name of the bundle.
slug
string
URL-friendly identifier for the bundle.
price_marked
number
Maximum Retail Price of the bundle.
price_effective
number
Current selling price of the bundle.
item_id
integer
Unique identifier for the item.
item_type
string
Type of the item (physical_bundle, virtual_bundle).
Enum
return_config
object
Refund Config for bundle product
Properties
allow_partial_return
boolean
Nullable
The line number of the parent bag.
returnable
boolean
Nullable
The line number of the parent bag.
unit
boolean
Nullable
The line number of the parent bag.
time
boolean
Nullable
The line number of the parent bag.
seller_identifier
string
Identifier for the seller of the bundle.
images
array of string
An array of image URLs associated with the bundle.
bundle_article_quantity
integer
Article net_quantity in bundle Product.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
dimensions
object
Required
The dimension object of the article/item
Properties
height
number|null
The height of the product
width
number|null
The width of the product
is_default
boolean|null
Whether the dimension is the default one or not
unit
string|null
The unit of dimension
length
number|null
The length of the product
weight
object
Required
Object containing weight details of item/article
Properties
unit
string
The unit of weight
shipping
number
The shipping weight of the product
is_default
boolean
Whether the weight is the default one or not
currency
object
Required
Order currency details
Properties
code
string
Currency code
rate
number
The conversion rate value
expiration_date
Undefined Type
Required
current_operational_status
object
Required
Properties
created_at
string
| date-time
Required
Date and time when the shipment status record was created
created_ts
string
Required
Timestamp indicating the exact time when the shipment status record was created
id
number
Required
Unique identifier for the shipment status record
kafka_sync
boolean
Required
Flag indicating whether the shipment status update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the shipment status record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the shipment status record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
ID of the fulfilling store of the shipment
status
string
Required
Current operational status of the shipment
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Details of the user who initiated the change in the shipment's status
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
affiliate_bag_details
object
Required
Object containing external bag details like external order id, external bag id
Properties
affiliate_bag_id
string
Required
External bag id
affiliate_order_id
string
Required
External order id
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
quantity
number
Required
Total quantity of the article present in the bag.
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
price_effective
number
Required
MRP - Initial Seller provided discount
discount
number
Required
The total amount discounted from the original MRP/actual price
amount_paid
number
Required
Amount paid by the customer
coupon_effective_discount
number
Required
Coupon provided by brand or seller
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cod_charges
number
Required
The fee associated with the COD order
refund_credit
number
Required
Refund credits provided to the customer
cashback
number
Required
Cashback points
refund_amount
number
Required
Amount to be refunded on cancellation and return
added_to_fynd_cash
boolean
Required
Flag indicating whether fynd cash has been used
cashback_applied
number
Required
Cashback applied on the order
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
value_of_good
number
Required
Effective selling price - Product GST Amount
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
transfer_price
number
Required
article
brand_calculated_amount
number
Required
Price Effective - Coupon Discount (Seller) - Promotion (Seller)
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
gift_price
number
Required
Gift card amount used
coupon_value
number
Required
Stores the coupon value as shown in the cart
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
amount_paid_roundoff
number
Required
Amount paid rounded off
loyalty_discount
number
Amount reduced from the payable price when the customer applies loyalty program points while placing the order
order_created
string
Required
Order creation timestamp
gst_details
object
Required
GST details associated with the bag
Properties
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
is_default_hsn_code
boolean
Required
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
hsn_code_id
string|null
Required
The unique identifier associated with HSN code
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
igst_tax_percentage
number
Required
Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions
sgst_tax_percentage
number
Required
Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state
cgst_tax_percentage
number
Required
Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state
igst_gst_fee
string|number
Required
Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions
cgst_gst_fee
string
Required
Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state
sgst_gst_fee
string
Required
Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state
tax_rule_id
string
ID of the tax rule associated with the product
line_number
number
Required
Unique identifier associated with each bag in a shipment
applied_promos
array of object
Required
Array of Properties
promo_id
string
Promotion id
buy_rules
array of object
Buy rules for promotions
Array of Properties
item_criteria
object
Item criteria of promotion
cart_conditions
object
Cart conditions details for promotion
offer_text
string
Offer text of current promotion
promotion_group
string
Promotion group for the promotion
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_name
string
Promotion name of current promotion
amount
number
Per unit discount amount applied with current promotion
discount_rules
array of object
Discount rules for promotions
Array of Properties
matched_buy_rules
array of string
Matched buy rules for promotion
raw_offer
object
raw offer details for promotion
offer
object
offer for promotion
item_criteria
object
Item criteria of promotion
ownership
object
Ownership of promotion
Properties
payable_category
string
promo amount payable category
payable_by
string
promo amount bearable party
article_quantity
integer
Quantity of article on which promotion is applicable
applied_free_articles
array of object
Applied free article for free gift item promotions
Array of Properties
free_gift_item_details
object
Free gift items details
Properties
item_slug
string
item slug
item_name
string
Item name
item_price_details
object
item price details
item_brand_name
string
item brand name
item_id
integer
Item id
item_images_url
array of string
item images URL
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
Free article quantity
article_id
string
free article id
promotion_type
string
Promotion type of current promotion
meta
object
Meta object for extra data
code
string|null
Promotion code
taxes
array of object
Required
Details of taxes applied on products
Array of Properties
name
string
Name of the tax applied (e.g., GST, CGST, SGST, VAT)
rate
number
Tax rate applied, represented as a decimal value (e.g., 0.09 for 9%)
taxable_amount
number
Amount on which the tax is calculated, after applicable discounts or exemptions
tax_amount
number
Final tax amount calculated using the tax rate on the taxable amount
bag_status_history
array of object
Required
Records the changes in status for a bag, providing a timeline of events and transitions
Array of Properties
created_at
string
| date-time
Required
Date and time when the bag status history record was created.
created_ts
string
Required
Timestamp indicating the exact time when the bag status history record was created
id
number
Required
Unique identifier for the bag status history record
kafka_sync
boolean
Required
Flag indicating whether the bag status history update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the bag status history record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the bag status history record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
Store id associated with the bag
status
string
Required
Webhook shipment status, i.e., either create or update
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
fulfilling_store
object
Required
Details of the store responsible for fulfilling the order
Properties
id
number
Required
Unique identifier for the store.
code
string
Required
Alphanumeric code representing the store.
name
string
Required
Name of the store.
address
string
Required
Physical address of the store.
state
string
Required
State where the store is located.
city
string
Required
City where the store is located.
pincode
string
Required
Postal code (pincode) of the store's location.
country
string
Required
Country where the store is situated.
phone
string
Required
Contact phone number for the store.
fulfillment_channel
string
Required
Type of fulfillment channel used by the store.
location_type
string
Required
Type of location e.g., warehouse, high_street
Enum
company_id
number
Required
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Required
Boolean indicating whether the store is currently active
tags
array of string
Required
Array of tags associated with the store
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
amount_paid
number
Required
Amount paid by the customer
refund_amount
number
Required
Amount to be refunded on cancellation and return
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
cod_charges
number
Required
The fee associated with the COD order
discount
number
Required
The total amount discounted from the original MRP/actual price
cashback_applied
number
Required
Cashback applied on the order
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cashback
number
Required
Cashback points
price_effective
number
Required
MRP - Initial Seller provided discount
refund_credit
number
Required
Refund credits provided to the customer
value_of_good
number
Required
Effective selling price - Product GST Amount
coupon_value
number
Required
Stores the coupon value as shown in the cart
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
cn_refund_amount
number
Required
Amount to be refunded through credit note
gift_price
number
Required
Gift card amount used
amount_paid_roundoff
number
Amount paid rounded off
loyalty_discount
number
Amount reduced from the payable price when the customer applies loyalty program points while placing the order
payments
object
Required
Object containing payment mode and payment breakup
Properties
id
number
Required
Unique identifier for the payment mode
mode
string
Required
Type or category of the payment mode (e.g., PP, COD)
logo
string
Required
URL or path to the logo/icon representing the payment mode
display_name
string
Required
Name or label used to display the payment mode
display_priority
number
Required
Priority order for displaying the payment mode
source
string
Required
Merchant of the payment mode (e.g., PartnerPay, JioPp)
is_active
boolean
Required
Boolean indicating whether the payment mode is currently active
affiliate_details
object
Required
Application related details like config, order_id, shipment id
Properties
id
string|number
Required
Identifier for the application, can be application_id or extension_id
affiliate_bag_id
string
Required
Identifier assigned by the application for the bag
affiliate_order_id
string
Required
Identifier of the order assigned by the application
company_affiliate_tag
string
Required
Tag associated with the bag from the application's company
affiliate_id
string
Required
Identifier for the application, can be application_id or extension_id
affiliate_shipment_id
string
Required
Identifier of the shipment assigned by the application
affiliate_store_id
string
Required
Identifier of the store assigned by the application
pdf_links
object
Required
PDF Links pushed by the application or extension
Properties
label_type
string
Required
Label type - external
invoice_type
string
Required
Invoice type - external
label
string
Label URL provided by the application or extension
invoice
string
Invoice URL provided by the application or extension
config
object
Required
Application configuration details
Properties
id
string|number
Identifier for the application, can be application_id or extension_id
name
string
Application name
token
null|string
Application token - deprecated
dp_assignment
boolean
Flag indicating whether auto DP assignment should happen from system
app_company_id
number|null|string
ID of the company from which order was placed
article_assignment
object
The article assignment settings
Properties
strategy
string
Enum
level
string
Enum
force_reassignment
boolean
Indicates whether force reassignment is enabled
sales_channel_logo
string
Logo URL of the application to which order belongs
ordering_channel_logo
string
Logo URL of the ordering channel
post_order_reassignment
boolean
Indicates whether post-order reassignment is enabled
dp_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
rto_address
object
Required
The address to which shipment should be delivered in case of RTO
Properties
company_id
number
Required
ID of the company fulfilling the shipment
id
number
Required
ID of the store where RTO should happen
name
string
Required
A string representing the store's name
store_address_json
object
Required
Store address details
Properties
version
string
Address version, to be deprecated
contact_person
string
Name of the contact person associated with the address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
name
string
A string representing the store's name
area
string
A string specifying the locality or area associated with the address
area_code
string
Area code of the address
area_code_slug
string
Unique identifier or slug for the area code associated with the address
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
city
string
A string denoting the city or municipality of the address
state
string
A string indicating the state or province of the address
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
longitude
number|string
The longitude of the address
sector
string
A string specifying the sector or district of the address if applicable
latitude
number|string
The latitude of the address
phone
string
Mobile phone number of recipient associated with the address
email
string
Email of the recipient associated with the address
address_type
string
Type of address (e.g., home, office, registered)
address_category
string
Category or classification of the address
created_at
string
| date-time
Date and time when the address was created
updated_at
string
| date-time
Date and time when the address was last updated
country_phone_code
string|null
Phone code for the country of the address
country_iso_code
string
ISO code representing the country of the address
country_code
string
ISO code representing the country of the address
display_address
string
Formatted display version of the address
code
string
Required
Alphanumeric code representing the store
location_type
string
Required
Type of location e.g., warehouse, high_street
address1
string
Required
"A string representing the first line of the address, typically containing street or building information"
address2
string
Required
"A string representing the second line of the address, which can be used for additional address details if needed"
display_address
string
Required
Formatted display version of the address
city
string
Required
A string denoting the city or municipality of the address
state
string
Required
A string indicating the state or province of the address
sector
string
Required
A string specifying the sector or district of the address if applicable
country
string
Required
A string indicating the country of the address
pincode
string
Required
A string indicating the postal code or PIN code of the address area
store_email
string
Required
Email of the recipient associated with the store
contact_person
string
Required
Name of the contact person associated with the address
phone
string
Required
Mobile phone number of recipient associated with the address
weight
object
Required
Shipment weight
Properties
value
number
Required
unit
string
Required
shipment_gst
object
Required
GST details associated with the shipment
Properties
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
store_invoice_id
string|null
Required
Invoice ID attached to the shipment
credit_note_id
string|null
Required
Credit Note ID attached to the shipment
order_created
string
Required
Order creation timestamp
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
payment_info
array of Undefined Type
Required
"Array of object containing payment methods used for placing an order."
order
object
Required
Order level details
Properties
ordering_channel
string
Required
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Nullable
To uniquely identify the source through which order has been placed.
affiliate_order_date
string|null
| date-time
Required
Order creation timestamp at application/extension end
affiliate_order_id
string
Required
Identifier of the order assigned by the application
fynd_order_id
string
Required
System generated unique identifier of the order
mode_of_payment
string
Required
Unique identifier associated with the payment mode
source
string
Required
Ordering source eg. affiliate, fynd
total_order_value
number
Required
Total order value
collect_by
string
Required
Whomsoever collected the money
refund_by
string
Required
Whomsoever will refund the money
order_value
number
Required
Value of the order
loyalty_discount_details
object
Applied loyalty discount information
Properties
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order
order_source
string
Required
Ordering source eg. affiliate, fynd
journey_type
string|null
Required
Journey type forward or return
einvoice_info
object
Required
Einvoice info if e-invoice is applicable
Properties
credit_note
object
Details of the reverse credit note einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
invoice
object
Details of the forward invoice einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
lock_status
boolean
Required
Lock status of the shipment
original_bag_list
array of number
Required
List of Bag ids when the order was created
shipment_update_time
number
Required
Last shipment update time
previous_shipment_id
string|null
Required
"ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition"
fyndstore_emp
object
Required
Fynd store employee details
ordering_store
object
Required
Store details from which order was placed in case of StoreOS
Properties
id
number
Unique identifier for the store.
code
string
Alphanumeric code representing the store.
name
string
Name of the store.
address
string
Physical address of the store.
state
string
State where the store is located.
city
string
City where the store is located.
pincode
string
Postal code (pincode) of the store's location.
country
string
Country where the store is situated.
phone
string
Contact phone number for the store.
fulfillment_channel
string
Type of fulfillment channel used by the store.
location_type
string
Type of location e.g., warehouse, high_street
Enum
company_id
number
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Boolean indicating whether the store is currently active
tags
array of string
Array of tags associated with the store
coupon
object
Required
Coupon related details
cart_info
object
Required
Cart related information
Properties
cart_id
string
Required
The unique identifier of the cart
cart_uid
number
Required
UID associated with the cart
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "properties": {77 "shipment": {78 "type": "object",79 "properties": {80 "status": {81 "type": "string",82 "description": "Webhook shipment status, i.e., either create or update"83 },84 "shipment_status": {85 "type": "object",86 "description": "Status of the shipment indicating its current stage",87 "properties": {88 "created_at": {89 "type": "string",90 "description": "Shipment status created timestamp"91 },92 "created_ts": {93 "type": "string",94 "description": "Shipment status created timestamp"95 },96 "id": {97 "type": "number",98 "description": "Unique identifier associated with the shipment's status object"99 },100 "updated_ts": {101 "type": "string",102 "description": "Shipment status updated timestamp"103 },104 "bag_list": {105 "type": "array",106 "description": "List of Bag ids transitioned in this shipment's status",107 "items": {108 "type": "string"109 }110 },111 "shipment_id": {112 "type": "string",113 "description": "Unique shipment no. that is auto-generated"114 },115 "status": {116 "type": "string",117 "description": "Shipment's operational status"118 },119 "current_shipment_status": {120 "type": "string",121 "description": "Current shipment's status; it can be financial, logistics or operational"122 },123 "status_created_at": {124 "type": "string"125 }126 },127 "required": [128 "created_at",129 "created_ts",130 "id",131 "updated_ts",132 "bag_list",133 "shipment_id",134 "status",135 "current_shipment_status",136 "status_created_at"137 ]138 },139 "application_id": {140 "type": "string",141 "description": "ID of the sales channel to which the shipment belongs"142 },143 "shipment_id": {144 "type": "string",145 "description": "Unique shipment no. that is auto-generated"146 },147 "company_id": {148 "type": "number",149 "description": "ID of the company fulfilling the shipment"150 },151 "app_company_id": {152 "type": [153 "number",154 "null",155 "string"156 ],157 "description": "ID of the company from which order was placed"158 },159 "order_id": {160 "type": "string",161 "description": "Unique ID of order in which the shipment is present"162 },163 "merchant_id": {164 "type": "string",165 "description": "Unique merchant id"166 },167 "user": {168 "type": "object",169 "description": "Purchaser's details such as name, last name, mobile no. and email",170 "properties": {171 "email": {172 "type": [173 "string",174 "null"175 ],176 "description": "Email address of the purchaser user"177 },178 "id": {179 "type": [180 "number",181 "null"182 ],183 "description": "Unique identifier for the purchaser user within the system"184 },185 "gender": {186 "type": [187 "null",188 "string"189 ],190 "description": "Gender of the purchaser user (e.g., male, female, other)"191 },192 "first_name": {193 "type": "string",194 "description": "First name of the purchaser user"195 },196 "external_customer_id": {197 "type": [198 "string",199 "null"200 ],201 "description": "External identifier associated with the purchaser user in another system"202 },203 "mobile": {204 "type": [205 "string",206 "null"207 ],208 "description": "Mobile phone number of the purchaser user"209 },210 "last_name": {211 "type": "string",212 "description": "Last name of the purchaser user"213 },214 "mongo_user_id": {215 "type": [216 "string",217 "null"218 ],219 "description": "User's object ID in mongodb collection"220 },221 "user_oid": {222 "type": [223 "string",224 "null"225 ],226 "description": "User Object ID assigned within the system"227 },228 "country_phone_code": {229 "type": [230 "string",231 "null"232 ],233 "description": "Country phone code associated with the purchaser user's mobile number"234 },235 "is_anonymous_user": {236 "type": "boolean",237 "description": "Flag indicating whether the user is anonymous"238 }239 }240 },241 "delivery_address": {242 "type": "object",243 "description": "Address where the shipment is to be delivered",244 "properties": {245 "area": {246 "type": "string",247 "description": "A string specifying the locality or area associated with the address"248 },249 "city": {250 "type": "string",251 "description": "A string denoting the city or municipality of the address"252 },253 "name": {254 "type": "string",255 "description": "A string representing the recipient's name or the organization name associated with the address"256 },257 "email": {258 "type": "string",259 "description": "Email of the recipient associated with the delivery address"260 },261 "phone": {262 "type": "string",263 "description": "Mobile phone number of recipient associated with the delivery address"264 },265 "state": {266 "type": "string",267 "description": "A string indicating the state or province of the delivery address"268 },269 "address": {270 "type": "string",271 "description": "\"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""272 },273 "country": {274 "type": "string",275 "description": "A string indicating the country of the address"276 },277 "pincode": {278 "type": "string",279 "description": "A string indicating the postal code or PIN code of the address area"280 },281 "user_id": {282 "type": [283 "number",284 "null"285 ],286 "description": "Unique identifier for the fulfilling user within the system"287 },288 "version": {289 "type": "string",290 "description": "Address version, to be deprecated"291 },292 "address1": {293 "type": "string",294 "description": "\"A string representing the first line of the address, typically containing street or building information\""295 },296 "address2": {297 "type": "string",298 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""299 },300 "landmark": {301 "type": "string",302 "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""303 },304 "latitude": {305 "type": [306 "number",307 "string"308 ],309 "description": "The latitude of the address"310 },311 "area_code": {312 "type": "string",313 "x-not-enum": true,314 "description": "Area code of the address"315 },316 "last_name": {317 "type": "string",318 "description": "Last name of the recipient associated with the delivery address"319 },320 "longitude": {321 "type": [322 "number",323 "string"324 ],325 "description": "The longitude of the address"326 },327 "created_at": {328 "type": "string",329 "format": "date-time",330 "description": "Date and time when the delivery address was created"331 },332 "first_name": {333 "type": "string",334 "description": "First name of the recipient associated with the delivery address"335 },336 "updated_at": {337 "type": "string",338 "format": "date-time",339 "description": "Date and time when the delivery address was last updated"340 },341 "address_type": {342 "type": "string",343 "x-not-enum": true,344 "description": "Type of address (e.g., home, office, registered)"345 },346 "geo_location": {347 "required": [],348 "description": "Geographic coordinates (latitude and longitude) of the delivery address",349 "type": "object",350 "properties": {351 "latitude": {352 "type": [353 "number",354 "string"355 ],356 "description": "The latitude of the geolocation"357 },358 "longitude": {359 "type": [360 "number",361 "string"362 ],363 "description": "The longitude of the geolocation"364 }365 }366 },367 "area_code_slug": {368 "type": "string",369 "description": "Unique identifier or slug for the area code associated with the address"370 },371 "contact_person": {372 "type": "string",373 "description": "Name of the contact person associated with the delivery address"374 },375 "display_address": {376 "type": "string",377 "description": "Formatted display version of the delivery address"378 },379 "address_category": {380 "type": "string",381 "x-not-enum": true,382 "description": "Category or classification of the delivery address"383 },384 "country_iso_code": {385 "type": "string",386 "x-not-enum": true,387 "description": "ISO code representing the country of the delivery address"388 },389 "country_phone_code": {390 "type": [391 "string",392 "null"393 ],394 "x-not-enum": true,395 "description": "Phone code for the country of the delivery address"396 }397 }398 },399 "billing_address": {400 "type": "object",401 "description": "Address by which the invoice is created",402 "properties": {403 "area": {404 "type": "string",405 "description": "A string specifying the locality or area associated with the address"406 },407 "city": {408 "type": "string",409 "description": "A string denoting the city or municipality of the address"410 },411 "name": {412 "type": "string",413 "description": "A string representing the billing user's name or the organization name associated with the address"414 },415 "email": {416 "type": "string",417 "description": "Email address associated with the billing address user"418 },419 "phone": {420 "type": "string",421 "description": "Phone number associated with the billing address user"422 },423 "state": {424 "type": "string",425 "description": "A string indicating the state or province of the billing address"426 },427 "address": {428 "type": "string",429 "description": "\"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""430 },431 "country": {432 "type": "string",433 "description": "A string indicating the country of the address"434 },435 "pincode": {436 "type": "string",437 "description": "A string indicating the postal code or PIN code of the address area"438 },439 "version": {440 "type": "string",441 "description": "Address version, to be deprecated"442 },443 "address1": {444 "type": "string",445 "description": "\"A string representing the first line of the address, typically containing street or building information\""446 },447 "address2": {448 "type": "string",449 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""450 },451 "landmark": {452 "type": "string",453 "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""454 },455 "latitude": {456 "type": [457 "number",458 "string"459 ],460 "description": "The latitude of the address"461 },462 "area_code": {463 "type": "string",464 "x-not-enum": true,465 "description": "Area code of the address"466 },467 "last_name": {468 "type": "string",469 "description": "Last name of the individual associated with the billing address"470 },471 "longitude": {472 "type": [473 "number",474 "string"475 ],476 "description": "The longitude of the address"477 },478 "created_at": {479 "type": "string",480 "format": "date-time",481 "description": "Date and time when the billing address was created"482 },483 "first_name": {484 "type": "string",485 "description": "First name of the individual associated with the billing address"486 },487 "updated_at": {488 "type": "string",489 "format": "date-time",490 "description": "Date and time when the billing address was last updated"491 },492 "address_type": {493 "type": "string",494 "x-not-enum": true,495 "description": "Type of address (e.g., home, office, registered)"496 },497 "geo_location": {498 "required": [],499 "description": "Geographic coordinates (latitude and longitude) of the billing address",500 "type": "object",501 "properties": {502 "latitude": {503 "type": [504 "number",505 "string"506 ],507 "description": "The latitude of the geolocation"508 },509 "longitude": {510 "type": [511 "number",512 "string"513 ],514 "description": "The longitude of the geolocation"515 }516 }517 },518 "area_code_slug": {519 "type": "string",520 "description": "Unique identifier or slug for the area code associated with the address"521 },522 "contact_person": {523 "type": "string",524 "description": "Name of the contact person associated with the billing address"525 },526 "display_address": {527 "type": "string",528 "description": "Formatted display version of the billing address"529 },530 "address_category": {531 "type": "string",532 "x-not-enum": true,533 "description": "Category or classification of the delivery address"534 },535 "country_iso_code": {536 "type": "string",537 "x-not-enum": true,538 "description": "ISO code representing the country of the delivery address"539 },540 "country_phone_code": {541 "type": [542 "string",543 "null"544 ],545 "x-not-enum": true,546 "description": "Phone code for the country of the delivery address"547 }548 }549 },550 "delivery_partner_details": {551 "type": "object",552 "description": "Delivery Partner details",553 "properties": {554 "id": {555 "type": [556 "string",557 "number",558 "null"559 ],560 "description": "Unique identifier for the delivery partner"561 },562 "name": {563 "type": [564 "string",565 "null"566 ],567 "description": "Name of the delivery partner"568 },569 "awb_no": {570 "type": [571 "string",572 "null"573 ],574 "description": "Airway Bill (AWB) number associated with the delivery"575 },576 "eway_bill_id": {577 "type": [578 "string",579 "null"580 ],581 "description": "Electronic Way Bill (E-way Bill) ID for the delivery"582 },583 "track_url": {584 "type": [585 "string",586 "null"587 ],588 "description": "URL to track the delivery status or shipment details"589 },590 "gst_tag": {591 "type": [592 "string",593 "null"594 ],595 "description": "GST tag of the shipment"596 },597 "extension_id": {598 "type": [599 "string",600 "null"601 ],602 "description": "Unique Identifier of Courier partner Extension"603 },604 "scheme_id": {605 "type": [606 "string",607 "null"608 ],609 "description": "Unique identifier of a Courier partner scheme"610 },611 "courier_partner_slug": {612 "type": [613 "string",614 "null"615 ],616 "description": "Unique identifier containing extension_id and scheme_id"617 }618 },619 "required": [620 "id",621 "name",622 "awb_no",623 "eway_bill_id",624 "track_url",625 "gst_tag",626 "extension_id",627 "scheme_id",628 "courier_partner_slug"629 ]630 },631 "bags": {632 "type": "array",633 "description": "Details of all the products/articles in a shipment",634 "items": {635 "type": "object",636 "properties": {637 "financial_breakup": {638 "type": "array",639 "description": "Financial breakup of an item",640 "items": {641 "type": "object",642 "properties": {643 "brand_calculated_amount": {644 "type": "number",645 "description": "Effective selling price - Brand's additional discounts"646 },647 "discount": {648 "type": "number",649 "description": "The total amount discounted from the original MRP/actual price"650 },651 "gst_fee": {652 "type": "number",653 "description": "The fee associated with Goods and Services Tax (GST) for a product or service"654 },655 "gst_tax_percentage": {656 "type": "number",657 "description": "The percentage rate of GST applied to a product or service"658 },659 "gst_tag": {660 "type": [661 "string",662 "null"663 ],664 "description": "Type of GST applied - IGST, CGST, SGST"665 },666 "hsn_code": {667 "type": [668 "string",669 "null"670 ],671 "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"672 },673 "identifiers": {674 "type": "object",675 "description": "Product identifiers",676 "properties": {677 "sku_code": {678 "type": "string",679 "description": "SKU code of the product"680 }681 }682 },683 "price_marked": {684 "type": "number",685 "description": "The indicated price or value assigned to an item before any discounts or adjustments"686 },687 "tax_collected_at_source": {688 "type": "number",689 "description": "The tax amount collected at the source of income or transaction"690 },691 "tcs_percentage": {692 "type": "number",693 "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"694 },695 "total_units": {696 "type": "number",697 "description": "Total number of units of the item"698 },699 "value_of_good": {700 "type": "number",701 "description": "Effective selling price - Product GST Amount"702 },703 "item_name": {704 "type": "string",705 "description": "The name of the item being referenced"706 },707 "size": {708 "type": "string",709 "description": "The physical dimensions or specifications of the item, indicating its size or measurements"710 },711 "loyalty_discount": {712 "type": "number",713 "description": "Amount reduced from the payable price when the customer applies loyalty program points while placing the order"714 }715 },716 "required": [717 "brand_calculated_amount",718 "discount",719 "gst_fee",720 "gst_tax_percentage",721 "gst_tag",722 "hsn_code",723 "identifiers",724 "price_marked",725 "tax_collected_at_source",726 "tcs_percentage",727 "total_units",728 "value_of_good",729 "item_name",730 "size"731 ]732 }733 },734 "entity_type": {735 "type": "string",736 "description": "Type of entity - bag, shipment"737 },738 "item": {739 "type": "object",740 "description": "Item details",741 "properties": {742 "l3_category_name": {743 "type": "string",744 "description": "The name of the level 3 category to which the item belongs"745 },746 "l1_category_id": {747 "type": "number",748 "description": "ID representing the level 2 category classification of the item"749 },750 "code": {751 "type": "string",752 "description": "A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes"753 },754 "branch_url": {755 "type": [756 "null",757 "string"758 ],759 "description": "Branch URL"760 },761 "l2_category": {762 "type": "array",763 "items": {764 "type": "string",765 "x-not-enum": true,766 "description": "The name of the level 2 category to which the item belongs"767 }768 },769 "l3_category": {770 "type": "number",771 "x-not-enum": true,772 "description": "ID representing the level 3 category classification of the item"773 },774 "last_updated_at": {775 "type": "string",776 "format": "date-time",777 "description": "Timestamp when the item was last updated"778 },779 "id": {780 "type": "number",781 "description": "ID of the item that is being referred"782 },783 "name": {784 "type": "string",785 "description": "The name of the item being referenced"786 },787 "can_return": {788 "type": "boolean",789 "description": "Flag indicating if the item is eligible for return"790 },791 "webstore_product_url": {792 "type": [793 "null",794 "string"795 ],796 "description": "Product URL"797 },798 "gender": {799 "type": [800 "null",801 "string"802 ],803 "description": "Gender associated with an item"804 },805 "l2_category_id": {806 "type": "number",807 "description": "ID representing the level 2 category classification of the item"808 },809 "color": {810 "type": [811 "null",812 "string"813 ],814 "description": "Color associated with and item"815 },816 "slug_key": {817 "type": "string",818 "description": "Automatically generated unique slug of the item"819 },820 "can_cancel": {821 "type": "boolean",822 "description": "Flag indicating if the item is eligible for cancellation"823 },824 "attributes": {825 "type": "object",826 "description": "An object containing descriptive properties of the item",827 "properties": {828 "name": {829 "type": "string",830 "description": "The name or title of the item"831 },832 "color": {833 "type": "string",834 "description": "The color description of the item"835 },836 "essential": {837 "type": "string",838 "description": "Indicates whether the item is considered essential"839 },840 "brand_name": {841 "type": "string",842 "description": "The brand name of the item"843 },844 "primary_color": {845 "type": "string",846 "description": "The primary color of the item"847 },848 "primary_color_hex": {849 "type": "string",850 "description": "The hexadecimal code representing the primary color"851 },852 "primary-colour-hex-code": {853 "type": "string",854 "description": "The hexadecimal code representing the primary color"855 },856 "media": {857 "type": "array",858 "description": "An array containing media files associated with the item",859 "items": {860 "type": "object"861 }862 }863 }864 },865 "brand_id": {866 "type": "number",867 "description": "The unique identifier associated with the brand of the item"868 },869 "brand": {870 "type": "string",871 "description": "The brand or manufacturer of the item"872 },873 "l1_category": {874 "type": "array",875 "items": {876 "type": "string",877 "x-not-enum": true,878 "description": "The name of the level 1 category to which the item belongs"879 }880 },881 "department_id": {882 "type": "number",883 "description": "The unique identifier representing the department or category to which the item belongs"884 },885 "size": {886 "type": "string",887 "description": "The size or dimensions of the item"888 },889 "image": {890 "type": "array",891 "items": {892 "type": "string",893 "description": "Url of the item's image"894 }895 }896 }897 },898 "brand": {899 "type": "object",900 "description": "Brand's information",901 "properties": {902 "credit_note_allowed": {903 "type": "boolean",904 "description": "If a credit note ID needs to be generated by the system"905 },906 "created_on": {907 "type": "string",908 "description": "Date and time when the brand was registered or created"909 },910 "id": {911 "type": "number",912 "description": "Unique identifier assigned to the brand for reference and identification"913 },914 "logo": {915 "type": "string",916 "description": "Visual representation or emblem associated with the brand"917 },918 "modified_on": {919 "type": "string",920 "description": "Date and time of the most recent update or modification to the brand's information"921 },922 "is_virtual_invoice": {923 "type": "boolean",924 "description": "If invoice ID needs to be generated by the system"925 },926 "brand_name": {927 "type": "string",928 "description": "Name or title of the brand used for identification and representation"929 }930 },931 "required": [932 "credit_note_allowed",933 "created_on",934 "id",935 "logo",936 "modified_on",937 "is_virtual_invoice",938 "brand_name"939 ]940 },941 "bag_id": {942 "type": "number",943 "description": "The unique identifier associated with the bag"944 },945 "article": {946 "type": "object",947 "description": "Details of the article",948 "properties": {949 "identifiers": {950 "type": "object",951 "description": "Product identifiers",952 "properties": {953 "sku_code": {954 "type": "string"955 }956 }957 },958 "esp_modified": {959 "type": [960 "string",961 "boolean"962 ],963 "description": "Flag representing if effective selling price has been modified"964 },965 "size": {966 "type": "string",967 "description": "The physical dimensions or specifications of the article, indicating its size or measurements"968 },969 "code": {970 "type": "string",971 "description": "A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes"972 },973 "set": {974 "description": "Details of the set article containing size distribution",975 "type": "object",976 "properties": {977 "quantity": {978 "type": "integer",979 "description": "Number of units present"980 },981 "size_distribution": {982 "type": "object",983 "description": "Object indicating the distribution of size and quantity of a set article",984 "properties": {985 "sizes": {986 "type": "array",987 "description": "Array indicating size wise units present in a set article",988 "items": {989 "type": "object",990 "description": "Object indicating the size and quantity distribution of a set article",991 "properties": {992 "pieces": {993 "type": "integer",994 "description": "Number of units of a particular size"995 },996 "size": {997 "type": "string",998 "description": "Size of the article"999 }1000 }1001 }1002 }1003 }1004 }1005 }1006 },1007 "is_set": {1008 "type": [1009 "string",1010 "boolean"1011 ],1012 "description": "A boolean indicating whether the article is a set"1013 },1014 "seller_identifier": {1015 "type": "string",1016 "description": "Seller's identifier of the article"1017 },1018 "return_config": {1019 "type": "object",1020 "description": "Return configuration details of the article",1021 "properties": {1022 "time": {1023 "type": "number",1024 "description": "Number indicating number of hours or days"1025 },1026 "unit": {1027 "type": "string",1028 "description": "String indicating the unit of the time, eg. days, hours"1029 },1030 "returnable": {1031 "type": "boolean",1032 "description": "Flag indicating whether product is returnable or not"1033 }1034 },1035 "required": [1036 "time",1037 "unit",1038 "returnable"1039 ]1040 },1041 "_id": {1042 "type": "string",1043 "description": "DB generated ID of the article"1044 },1045 "uid": {1046 "type": "string",1047 "description": "UID of the article"1048 },1049 "child_details": {1050 "type": [1051 "object",1052 "array"1053 ],1054 "description": "Child article details if any",1055 "properties": {},1056 "required": []1057 },1058 "bundle_details": {1059 "type": "object",1060 "description": "Contains bundle-related metadata for the shipment.",1061 "properties": {1062 "bundle_group_id": {1063 "type": "string",1064 "description": "Unique group identifier for the bundle."1065 },1066 "name": {1067 "type": "string",1068 "description": "Name of the bundle."1069 },1070 "slug": {1071 "type": "string",1072 "description": "URL-friendly identifier for the bundle."1073 },1074 "price_marked": {1075 "type": "number",1076 "description": "Maximum Retail Price of the bundle."1077 },1078 "price_effective": {1079 "type": "number",1080 "description": "Current selling price of the bundle."1081 },1082 "item_id": {1083 "type": "integer",1084 "description": "Unique identifier for the item."1085 },1086 "item_type": {1087 "type": "string",1088 "description": "Type of the item (physical_bundle, virtual_bundle).",1089 "enum": [1090 "virtual_bundle",1091 "physical_bundle"1092 ]1093 },1094 "return_config": {1095 "description": "Refund Config for bundle product",1096 "type": "object",1097 "properties": {1098 "allow_partial_return": {1099 "type": "boolean",1100 "nullable": true,1101 "description": "The line number of the parent bag."1102 },1103 "returnable": {1104 "type": "boolean",1105 "nullable": true,1106 "description": "The line number of the parent bag."1107 },1108 "unit": {1109 "type": "boolean",1110 "nullable": true,1111 "description": "The line number of the parent bag."1112 },1113 "time": {1114 "type": "boolean",1115 "nullable": true,1116 "description": "The line number of the parent bag."1117 }1118 }1119 },1120 "seller_identifier": {1121 "type": "string",1122 "description": "Identifier for the seller of the bundle."1123 },1124 "images": {1125 "type": "array",1126 "items": {1127 "type": "string"1128 },1129 "description": "An array of image URLs associated with the bundle."1130 },1131 "bundle_article_quantity": {1132 "type": "integer",1133 "description": "Article net_quantity in bundle Product."1134 },1135 "brand_name": {1136 "type": "string",1137 "description": "Identifier for the brand name."1138 },1139 "size": {1140 "type": "string",1141 "description": "Size associated with the bundle item."1142 }1143 }1144 },1145 "dimensions": {1146 "description": "The dimension object of the article/item",1147 "required": [],1148 "type": "object",1149 "properties": {1150 "height": {1151 "type": [1152 "number",1153 "null"1154 ],1155 "description": "The height of the product"1156 },1157 "width": {1158 "type": [1159 "number",1160 "null"1161 ],1162 "description": "The width of the product"1163 },1164 "is_default": {1165 "type": [1166 "boolean",1167 "null"1168 ],1169 "description": "Whether the dimension is the default one or not"1170 },1171 "unit": {1172 "type": [1173 "string",1174 "null"1175 ],1176 "description": "The unit of dimension"1177 },1178 "length": {1179 "type": [1180 "number",1181 "null"1182 ],1183 "description": "The length of the product"1184 }1185 }1186 },1187 "weight": {1188 "required": [],1189 "type": "object",1190 "description": "Object containing weight details of item/article",1191 "properties": {1192 "unit": {1193 "type": "string",1194 "description": "The unit of weight",1195 "example": "kg"1196 },1197 "shipping": {1198 "type": "number",1199 "description": "The shipping weight of the product",1200 "example": 1.51201 },1202 "is_default": {1203 "type": "boolean",1204 "description": "Whether the weight is the default one or not",1205 "example": true1206 }1207 }1208 },1209 "currency": {1210 "type": "object",1211 "description": "Order currency details",1212 "properties": {1213 "code": {1214 "type": "string",1215 "description": "Currency code"1216 },1217 "rate": {1218 "type": "number",1219 "description": "The conversion rate value"1220 }1221 },1222 "required": []1223 },1224 "expiration_date": {}1225 },1226 "required": [1227 "identifiers",1228 "esp_modified",1229 "size",1230 "code",1231 "set",1232 "is_set",1233 "seller_identifier",1234 "return_config",1235 "_id",1236 "uid",1237 "child_details",1238 "dimensions",1239 "weight",1240 "currency",1241 "expiration_date"1242 ]1243 },1244 "current_operational_status": {1245 "type": "object",1246 "properties": {1247 "created_at": {1248 "type": "string",1249 "format": "date-time",1250 "description": "Date and time when the shipment status record was created"1251 },1252 "created_ts": {1253 "type": "string",1254 "description": "Timestamp indicating the exact time when the shipment status record was created"1255 },1256 "id": {1257 "type": "number",1258 "description": "Unique identifier for the shipment status record"1259 },1260 "kafka_sync": {1261 "type": "boolean",1262 "description": "Flag indicating whether the shipment status update has been sync with Kafka"1263 },1264 "updated_ts": {1265 "type": "string",1266 "description": "Timestamp indicating the last time the shipment status record was updated"1267 },1268 "updated_at": {1269 "type": "string",1270 "format": "date-time",1271 "description": "Date and time of the most recent update to the shipment status record"1272 },1273 "delivery_partner_id": {1274 "type": [1275 "integer",1276 "null"1277 ],1278 "description": "Unique identifier of delivery partner"1279 },1280 "shipment_id": {1281 "type": "string",1282 "description": "Unique shipment no. that is auto-generated"1283 },1284 "store_id": {1285 "type": "number",1286 "description": "ID of the fulfilling store of the shipment"1287 },1288 "status": {1289 "type": "string",1290 "description": "Current operational status of the shipment"1291 },1292 "bag_id": {1293 "type": "number",1294 "description": "The unique identifier associated with the bag"1295 },1296 "state_id": {1297 "type": "number",1298 "description": "The unique identifier associated with the state"1299 },1300 "state_type": {1301 "type": "string",1302 "enum": [1303 "operational",1304 "logistics",1305 "financial"1306 ],1307 "description": "Type of the state - operational, logistics, financial"1308 },1309 "delivery_awb_number": {1310 "type": [1311 "string",1312 "null"1313 ],1314 "description": "Airway Bill (AWB) number associated with the delivery"1315 },1316 "bag_state_mapper": {1317 "type": "object",1318 "description": "Object representing properties of the state",1319 "properties": {1320 "journey_type": {1321 "type": [1322 "string",1323 "null"1324 ],1325 "enum": [1326 "forward",1327 "return"1328 ],1329 "description": "Journey type can be forward or return"1330 },1331 "app_display_name": {1332 "type": "string",1333 "description": "The display name of a shipment status as it appears on the sale channel's website"1334 },1335 "state_type": {1336 "type": "string",1337 "enum": [1338 "operational",1339 "logistics",1340 "financial"1341 ],1342 "description": "Type of the state - operational, logistics, financial"1343 },1344 "app_state_name": {1345 "type": "string",1346 "description": "The slug of a shipment status from the sale channel's front"1347 },1348 "name": {1349 "type": "string",1350 "description": "The slug of a shipment status from the platform's front"1351 },1352 "app_facing": {1353 "type": "boolean",1354 "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"1355 },1356 "id": {1357 "type": "number",1358 "description": "The unique identifier associated with the state"1359 },1360 "display_name": {1361 "type": "string",1362 "description": "The display name of a shipment status as it appears on the platform"1363 },1364 "is_active": {1365 "type": "boolean",1366 "description": "A boolean flag indicating whether a state is active or not"1367 }1368 },1369 "required": [1370 "journey_type",1371 "app_display_name",1372 "state_type",1373 "app_state_name",1374 "name",1375 "app_facing",1376 "id",1377 "display_name",1378 "is_active"1379 ]1380 },1381 "reasons": {1382 "type": "array",1383 "items": {1384 "type": "object",1385 "properties": {1386 "slug": {1387 "type": "string",1388 "description": "System generated slug"1389 },1390 "display_name": {1391 "type": "string",1392 "description": "Text that is displayed on the application front"1393 },1394 "id": {1395 "type": "integer",1396 "description": "System generated ID of the reason object"1397 },1398 "state": {1399 "type": [1400 "integer",1401 "string"1402 ],1403 "description": "State associated with the reason"1404 },1405 "text": {1406 "type": "string",1407 "description": "Reason text"1408 },1409 "quantity": {1410 "type": "integer",1411 "description": "No of quantity that is being cancelled"1412 },1413 "inventory_flag": {1414 "type": "boolean",1415 "description": "Inventory depletion action to be taken or not"1416 }1417 }1418 },1419 "description": "Reasons associated with the current shipment's status"1420 },1421 "action_user": {1422 "description": "Details of the user who initiated the change in the shipment's status",1423 "required": [],1424 "type": "object",1425 "properties": {1426 "title": {1427 "type": "string",1428 "description": "The title of the user eg. Staff, Admin",1429 "example": "Staff"1430 },1431 "user_id": {1432 "type": "string",1433 "description": "System generated ID associated with the user",1434 "example": "23546659"1435 },1436 "user_name": {1437 "type": "string",1438 "description": "System generated username associated with the user",1439 "example": "65967faf620ff7c9db513d9c"1440 },1441 "order_role": {1442 "type": "string",1443 "description": "Order role associated with the user eg. company_operation, store_manager",1444 "example": "full_access"1445 },1446 "employee_code": {1447 "type": "string",1448 "x-not-enum": true,1449 "description": "Employee code associated with the user",1450 "example": "EM-102"1451 }1452 }1453 }1454 },1455 "required": [1456 "created_at",1457 "created_ts",1458 "id",1459 "kafka_sync",1460 "updated_ts",1461 "updated_at",1462 "delivery_partner_id",1463 "shipment_id",1464 "store_id",1465 "status",1466 "bag_id",1467 "state_id",1468 "state_type",1469 "delivery_awb_number",1470 "bag_state_mapper",1471 "reasons",1472 "action_user"1473 ]1474 },1475 "affiliate_bag_details": {1476 "type": "object",1477 "description": "Object containing external bag details like external order id, external bag id",1478 "properties": {1479 "affiliate_bag_id": {1480 "type": "string",1481 "description": "External bag id"1482 },1483 "affiliate_order_id": {1484 "type": "string",1485 "description": "External order id"1486 }1487 },1488 "required": [1489 "affiliate_bag_id",1490 "affiliate_order_id"1491 ]1492 },1493 "payment_methods": {1494 "type": "object",1495 "description": "\"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details.\""1496 },1497 "quantity": {1498 "type": "number",1499 "description": "Total quantity of the article present in the bag."1500 },1501 "prices": {1502 "type": "object",1503 "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",1504 "properties": {1505 "price_effective": {1506 "type": "number",1507 "description": "MRP - Initial Seller provided discount"1508 },1509 "discount": {1510 "type": "number",1511 "description": "The total amount discounted from the original MRP/actual price"1512 },1513 "amount_paid": {1514 "type": "number",1515 "description": "Amount paid by the customer"1516 },1517 "coupon_effective_discount": {1518 "type": "number",1519 "description": "Coupon provided by brand or seller"1520 },1521 "delivery_charge": {1522 "type": "number",1523 "description": "The fee associated with the delivery service for transporting the item to its destination"1524 },1525 "fynd_credits": {1526 "type": "number",1527 "description": "Credits provided by Fynd"1528 },1529 "cod_charges": {1530 "type": "number",1531 "description": "The fee associated with the COD order"1532 },1533 "refund_credit": {1534 "type": "number",1535 "description": "Refund credits provided to the customer"1536 },1537 "cashback": {1538 "type": "number",1539 "description": "Cashback points"1540 },1541 "refund_amount": {1542 "type": "number",1543 "description": "Amount to be refunded on cancellation and return"1544 },1545 "added_to_fynd_cash": {1546 "type": "boolean",1547 "description": "Flag indicating whether fynd cash has been used"1548 },1549 "cashback_applied": {1550 "type": "number",1551 "description": "Cashback applied on the order"1552 },1553 "gst_tax_percentage": {1554 "type": "number",1555 "description": "The percentage rate of GST applied to a product or service"1556 },1557 "value_of_good": {1558 "type": "number",1559 "description": "Effective selling price - Product GST Amount"1560 },1561 "price_marked": {1562 "type": "number",1563 "description": "The indicated price or value assigned to an item before any discounts or adjustments"1564 },1565 "transfer_price": {1566 "type": "number",1567 "description": "article"1568 },1569 "brand_calculated_amount": {1570 "type": "number",1571 "description": "Price Effective - Coupon Discount (Seller) - Promotion (Seller)"1572 },1573 "tax_collected_at_source": {1574 "type": "number",1575 "description": "The tax amount collected at the source of income or transaction"1576 },1577 "tcs_percentage": {1578 "type": "number",1579 "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"1580 },1581 "promotion_effective_discount": {1582 "type": "number",1583 "description": "Effective promotion discount including promotions given by seller and Platform"1584 },1585 "gift_price": {1586 "type": "number",1587 "description": "Gift card amount used"1588 },1589 "coupon_value": {1590 "type": "number",1591 "description": "Stores the coupon value as shown in the cart"1592 },1593 "seller_promotion_effective_discount": {1594 "type": "number",1595 "description": "Promotion discount given by the seller"1596 },1597 "fynd_promotion_effective_discount": {1598 "type": "number",1599 "description": "Promotion discount given by Platform/fynd"1600 },1601 "amount_paid_roundoff": {1602 "type": "number",1603 "description": "Amount paid rounded off"1604 },1605 "loyalty_discount": {1606 "type": "number",1607 "description": "Amount reduced from the payable price when the customer applies loyalty program points while placing the order"1608 }1609 },1610 "required": [1611 "price_effective",1612 "discount",1613 "amount_paid",1614 "coupon_effective_discount",1615 "delivery_charge",1616 "fynd_credits",1617 "cod_charges",1618 "refund_credit",1619 "cashback",1620 "refund_amount",1621 "added_to_fynd_cash",1622 "cashback_applied",1623 "gst_tax_percentage",1624 "value_of_good",1625 "price_marked",1626 "transfer_price",1627 "brand_calculated_amount",1628 "tax_collected_at_source",1629 "tcs_percentage",1630 "promotion_effective_discount",1631 "gift_price",1632 "coupon_value",1633 "seller_promotion_effective_discount",1634 "fynd_promotion_effective_discount",1635 "amount_paid_roundoff"1636 ]1637 },1638 "order_created": {1639 "type": "string",1640 "description": "Order creation timestamp"1641 },1642 "gst_details": {1643 "type": "object",1644 "description": "GST details associated with the bag",1645 "properties": {1646 "gstin_code": {1647 "type": [1648 "string",1649 "null"1650 ],1651 "x-not-enum": true,1652 "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"1653 },1654 "gst_tag": {1655 "type": [1656 "string",1657 "null"1658 ],1659 "description": "Type of GST applied - IGST, CGST, SGST"1660 },1661 "hsn_code": {1662 "type": [1663 "string",1664 "null"1665 ],1666 "x-not-enum": true,1667 "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"1668 },1669 "value_of_good": {1670 "type": "number",1671 "description": "Effective selling price - Product GST Amount"1672 },1673 "gst_tax_percentage": {1674 "type": "number",1675 "description": "The percentage rate of GST applied to a product or service"1676 },1677 "is_default_hsn_code": {1678 "type": "boolean"1679 },1680 "brand_calculated_amount": {1681 "type": "number",1682 "description": "Effective selling price - Brand's additional discounts"1683 },1684 "tax_collected_at_source": {1685 "type": "number",1686 "description": "The tax amount collected at the source of income or transaction"1687 },1688 "hsn_code_id": {1689 "type": [1690 "string",1691 "null"1692 ],1693 "description": "The unique identifier associated with HSN code"1694 },1695 "gst_fee": {1696 "type": "number",1697 "description": "The fee associated with Goods and Services Tax (GST) for a product or service"1698 },1699 "igst_tax_percentage": {1700 "type": "number",1701 "description": "Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions"1702 },1703 "sgst_tax_percentage": {1704 "type": "number",1705 "description": "Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state"1706 },1707 "cgst_tax_percentage": {1708 "type": "number",1709 "description": "Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state"1710 },1711 "igst_gst_fee": {1712 "type": [1713 "string",1714 "number"1715 ],1716 "description": "Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions"1717 },1718 "cgst_gst_fee": {1719 "type": "string",1720 "description": "Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state"1721 },1722 "sgst_gst_fee": {1723 "type": "string",1724 "description": "Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state"1725 },1726 "tax_rule_id": {1727 "type": "string",1728 "description": "ID of the tax rule associated with the product"1729 }1730 },1731 "required": [1732 "gstin_code",1733 "gst_tag",1734 "hsn_code",1735 "value_of_good",1736 "gst_tax_percentage",1737 "is_default_hsn_code",1738 "brand_calculated_amount",1739 "tax_collected_at_source",1740 "hsn_code_id",1741 "gst_fee",1742 "igst_tax_percentage",1743 "sgst_tax_percentage",1744 "cgst_tax_percentage",1745 "igst_gst_fee",1746 "cgst_gst_fee",1747 "sgst_gst_fee"1748 ]1749 },1750 "line_number": {1751 "type": "number",1752 "description": "Unique identifier associated with each bag in a shipment"1753 },1754 "applied_promos": {1755 "type": "array",1756 "items": {1757 "type": "object",1758 "properties": {1759 "promo_id": {1760 "type": "string",1761 "description": "Promotion id"1762 },1763 "buy_rules": {1764 "description": "Buy rules for promotions",1765 "type": "array",1766 "items": {1767 "type": "object",1768 "properties": {1769 "item_criteria": {1770 "type": "object",1771 "description": "Item criteria of promotion"1772 },1773 "cart_conditions": {1774 "type": "object",1775 "description": "Cart conditions details for promotion"1776 }1777 }1778 }1779 },1780 "offer_text": {1781 "type": "string",1782 "description": "Offer text of current promotion"1783 },1784 "promotion_group": {1785 "type": "string",1786 "description": "Promotion group for the promotion"1787 },1788 "mrp_promotion": {1789 "type": "boolean",1790 "description": "If applied promotion is applied on product MRP or ESP"1791 },1792 "promotion_name": {1793 "type": "string",1794 "description": "Promotion name of current promotion"1795 },1796 "amount": {1797 "type": "number",1798 "description": "Per unit discount amount applied with current promotion"1799 },1800 "discount_rules": {1801 "description": "Discount rules for promotions",1802 "type": "array",1803 "items": {1804 "type": "object",1805 "properties": {1806 "matched_buy_rules": {1807 "type": "array",1808 "description": "Matched buy rules for promotion",1809 "items": {1810 "type": "string"1811 }1812 },1813 "raw_offer": {1814 "type": "object",1815 "description": "raw offer details for promotion"1816 },1817 "offer": {1818 "type": "object",1819 "description": "offer for promotion"1820 },1821 "item_criteria": {1822 "type": "object",1823 "description": "Item criteria of promotion"1824 }1825 }1826 }1827 },1828 "ownership": {1829 "type": "object",1830 "description": "Ownership of promotion",1831 "properties": {1832 "payable_category": {1833 "type": "string",1834 "x-not-enum": true,1835 "description": "promo amount payable category"1836 },1837 "payable_by": {1838 "type": "string",1839 "description": "promo amount bearable party"1840 }1841 }1842 },1843 "article_quantity": {1844 "type": "integer",1845 "description": "Quantity of article on which promotion is applicable"1846 },1847 "applied_free_articles": {1848 "description": "Applied free article for free gift item promotions",1849 "type": "array",1850 "items": {1851 "type": "object",1852 "properties": {1853 "free_gift_item_details": {1854 "description": "Free gift items details",1855 "type": "object",1856 "properties": {1857 "item_slug": {1858 "type": "string",1859 "description": "item slug"1860 },1861 "item_name": {1862 "type": "string",1863 "description": "Item name"1864 },1865 "item_price_details": {1866 "type": "object",1867 "description": "item price details"1868 },1869 "item_brand_name": {1870 "type": "string",1871 "description": "item brand name"1872 },1873 "item_id": {1874 "type": "integer",1875 "description": "Item id"1876 },1877 "item_images_url": {1878 "type": "array",1879 "description": "item images URL",1880 "items": {1881 "type": "string"1882 }1883 }1884 }1885 },1886 "parent_item_identifier": {1887 "type": "string",1888 "description": "Parent item identifier for free article"1889 },1890 "quantity": {1891 "type": "integer",1892 "description": "Free article quantity"1893 },1894 "article_id": {1895 "type": "string",1896 "description": "free article id"1897 }1898 }1899 }1900 },1901 "promotion_type": {1902 "type": "string",1903 "x-not-enum": true,1904 "description": "Promotion type of current promotion"1905 },1906 "meta": {1907 "type": "object",1908 "additionalProperties": true,1909 "description": "Meta object for extra data"1910 },1911 "code": {1912 "type": [1913 "string",1914 "null"1915 ],1916 "description": "Promotion code"1917 }1918 }1919 }1920 },1921 "taxes": {1922 "type": "array",1923 "description": "Details of taxes applied on products",1924 "items": {1925 "type": "object",1926 "properties": {1927 "name": {1928 "type": "string",1929 "description": "Name of the tax applied (e.g., GST, CGST, SGST, VAT)"1930 },1931 "rate": {1932 "type": "number",1933 "description": "Tax rate applied, represented as a decimal value (e.g., 0.09 for 9%)"1934 },1935 "taxable_amount": {1936 "type": "number",1937 "description": "Amount on which the tax is calculated, after applicable discounts or exemptions"1938 },1939 "tax_amount": {1940 "type": "number",1941 "description": "Final tax amount calculated using the tax rate on the taxable amount"1942 }1943 }1944 }1945 }1946 },1947 "required": [1948 "financial_breakup",1949 "entity_type",1950 "item",1951 "brand",1952 "bag_id",1953 "article",1954 "current_operational_status",1955 "affiliate_bag_details",1956 "payment_methods",1957 "quantity",1958 "prices",1959 "order_created",1960 "gst_details",1961 "line_number",1962 "applied_promos",1963 "taxes"1964 ]1965 }1966 },1967 "bag_status_history": {1968 "type": "array",1969 "description": "Records the changes in status for a bag, providing a timeline of events and transitions",1970 "items": {1971 "type": "object",1972 "properties": {1973 "created_at": {1974 "type": "string",1975 "format": "date-time",1976 "description": "Date and time when the bag status history record was created."1977 },1978 "created_ts": {1979 "type": "string",1980 "description": "Timestamp indicating the exact time when the bag status history record was created"1981 },1982 "id": {1983 "type": "number",1984 "description": "Unique identifier for the bag status history record"1985 },1986 "kafka_sync": {1987 "type": "boolean",1988 "description": "Flag indicating whether the bag status history update has been sync with Kafka"1989 },1990 "updated_ts": {1991 "type": "string",1992 "description": "Timestamp indicating the last time the bag status history record was updated"1993 },1994 "updated_at": {1995 "format": "date-time",1996 "type": "string",1997 "description": "Date and time of the most recent update to the bag status history record"1998 },1999 "delivery_partner_id": {2000 "type": [2001 "integer",2002 "null"2003 ],2004 "description": "Unique identifier of delivery partner"2005 },2006 "shipment_id": {2007 "type": "string",2008 "description": "Unique shipment no. that is auto-generated"2009 },2010 "store_id": {2011 "type": "number",2012 "description": "Store id associated with the bag"2013 },2014 "status": {2015 "type": "string",2016 "description": "Webhook shipment status, i.e., either create or update"2017 },2018 "bag_id": {2019 "type": "number",2020 "description": "The unique identifier associated with the bag"2021 },2022 "state_id": {2023 "type": "number",2024 "description": "The unique identifier associated with the state"2025 },2026 "state_type": {2027 "type": "string",2028 "enum": [2029 "operational",2030 "logistics",2031 "financial"2032 ],2033 "description": "Type of the state - operational, logistics, financial"2034 },2035 "delivery_awb_number": {2036 "type": [2037 "string",2038 "null"2039 ],2040 "description": "Airway Bill (AWB) number associated with the delivery"2041 },2042 "bag_state_mapper": {2043 "type": "object",2044 "description": "Object representing properties of the state",2045 "properties": {2046 "journey_type": {2047 "type": [2048 "string",2049 "null"2050 ],2051 "enum": [2052 "forward",2053 "return"2054 ],2055 "description": "Journey type can be forward or return"2056 },2057 "app_display_name": {2058 "type": "string",2059 "description": "The display name of a shipment status as it appears on the sale channel's website"2060 },2061 "state_type": {2062 "type": "string",2063 "enum": [2064 "operational",2065 "logistics",2066 "financial"2067 ],2068 "description": "Type of the state - operational, logistics, financial"2069 },2070 "app_state_name": {2071 "type": "string",2072 "description": "The slug of a shipment status from the sale channel's front"2073 },2074 "name": {2075 "type": "string",2076 "description": "The slug of a shipment status from the platform's front"2077 },2078 "app_facing": {2079 "type": "boolean",2080 "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"2081 },2082 "id": {2083 "type": "number",2084 "description": "The unique identifier associated with the state"2085 },2086 "display_name": {2087 "type": "string",2088 "description": "The display name of a shipment status as it appears on the platform"2089 },2090 "is_active": {2091 "type": "boolean",2092 "description": "A boolean flag indicating whether a state is active or not"2093 }2094 },2095 "required": [2096 "journey_type",2097 "app_display_name",2098 "state_type",2099 "app_state_name",2100 "name",2101 "app_facing",2102 "id",2103 "display_name",2104 "is_active"2105 ]2106 },2107 "reasons": {2108 "type": "array",2109 "items": {2110 "type": "object",2111 "properties": {2112 "slug": {2113 "type": "string",2114 "description": "System generated slug"2115 },2116 "display_name": {2117 "type": "string",2118 "description": "Text that is displayed on the application front"2119 },2120 "id": {2121 "type": "integer",2122 "description": "System generated ID of the reason object"2123 },2124 "state": {2125 "type": [2126 "integer",2127 "string"2128 ],2129 "description": "State associated with the reason"2130 },2131 "text": {2132 "type": "string",2133 "description": "Reason text"2134 },2135 "quantity": {2136 "type": "integer",2137 "description": "No of quantity that is being cancelled"2138 },2139 "inventory_flag": {2140 "type": "boolean",2141 "description": "Inventory depletion action to be taken or not"2142 }2143 }2144 },2145 "description": "Reasons associated with the current shipment's status"2146 },2147 "action_user": {2148 "type": "object",2149 "properties": {2150 "title": {2151 "type": "string",2152 "description": "The title of the user eg. Staff, Admin",2153 "example": "Staff"2154 },2155 "user_id": {2156 "type": "string",2157 "description": "System generated ID associated with the user",2158 "example": "23546659"2159 },2160 "user_name": {2161 "type": "string",2162 "description": "System generated username associated with the user",2163 "example": "65967faf620ff7c9db513d9c"2164 },2165 "order_role": {2166 "type": "string",2167 "description": "Order role associated with the user eg. company_operation, store_manager",2168 "example": "full_access"2169 },2170 "employee_code": {2171 "type": "string",2172 "x-not-enum": true,2173 "description": "Employee code associated with the user",2174 "example": "EM-102"2175 }2176 },2177 "required": []2178 }2179 },2180 "required": [2181 "created_at",2182 "created_ts",2183 "id",2184 "kafka_sync",2185 "updated_ts",2186 "updated_at",2187 "delivery_partner_id",2188 "shipment_id",2189 "store_id",2190 "status",2191 "bag_id",2192 "state_id",2193 "state_type",2194 "delivery_awb_number",2195 "bag_state_mapper",2196 "reasons",2197 "action_user"2198 ]2199 }2200 },2201 "fulfilling_store": {2202 "description": "Details of the store responsible for fulfilling the order",2203 "type": "object",2204 "properties": {2205 "id": {2206 "type": "number",2207 "description": "Unique identifier for the store."2208 },2209 "code": {2210 "type": "string",2211 "description": "Alphanumeric code representing the store."2212 },2213 "name": {2214 "type": "string",2215 "description": "Name of the store."2216 },2217 "address": {2218 "type": "string",2219 "description": "Physical address of the store."2220 },2221 "state": {2222 "type": "string",2223 "description": "State where the store is located."2224 },2225 "city": {2226 "type": "string",2227 "description": "City where the store is located."2228 },2229 "pincode": {2230 "type": "string",2231 "description": "Postal code (pincode) of the store's location."2232 },2233 "country": {2234 "type": "string",2235 "description": "Country where the store is situated."2236 },2237 "phone": {2238 "type": "string",2239 "description": "Contact phone number for the store."2240 },2241 "fulfillment_channel": {2242 "type": "string",2243 "description": "Type of fulfillment channel used by the store."2244 },2245 "location_type": {2246 "type": "string",2247 "enum": [2248 "high_street",2249 "mall",2250 "store",2251 "warehouse"2252 ],2253 "description": "Type of location e.g., warehouse, high_street"2254 },2255 "company_id": {2256 "type": "number",2257 "description": "Identifier of the company responsible for fulfilling shipments from this store"2258 },2259 "is_active": {2260 "type": "boolean",2261 "description": "Boolean indicating whether the store is currently active"2262 },2263 "tags": {2264 "type": "array",2265 "items": {2266 "type": "string"2267 },2268 "description": "Array of tags associated with the store"2269 }2270 },2271 "required": [2272 "id",2273 "code",2274 "name",2275 "address",2276 "state",2277 "city",2278 "pincode",2279 "country",2280 "phone",2281 "fulfillment_channel",2282 "location_type",2283 "company_id",2284 "is_active",2285 "tags"2286 ]2287 },2288 "prices": {2289 "type": "object",2290 "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",2291 "properties": {2292 "amount_paid": {2293 "type": "number",2294 "description": "Amount paid by the customer"2295 },2296 "refund_amount": {2297 "type": "number",2298 "description": "Amount to be refunded on cancellation and return"2299 },2300 "price_marked": {2301 "type": "number",2302 "description": "The indicated price or value assigned to an item before any discounts or adjustments"2303 },2304 "cod_charges": {2305 "type": "number",2306 "description": "The fee associated with the COD order"2307 },2308 "discount": {2309 "type": "number",2310 "description": "The total amount discounted from the original MRP/actual price"2311 },2312 "cashback_applied": {2313 "type": "number",2314 "description": "Cashback applied on the order"2315 },2316 "delivery_charge": {2317 "type": "number",2318 "description": "The fee associated with the delivery service for transporting the item to its destination"2319 },2320 "fynd_credits": {2321 "type": "number",2322 "description": "Credits provided by Fynd"2323 },2324 "cashback": {2325 "type": "number",2326 "description": "Cashback points"2327 },2328 "price_effective": {2329 "type": "number",2330 "description": "MRP - Initial Seller provided discount"2331 },2332 "refund_credit": {2333 "type": "number",2334 "description": "Refund credits provided to the customer"2335 },2336 "value_of_good": {2337 "type": "number",2338 "description": "Effective selling price - Product GST Amount"2339 },2340 "coupon_value": {2341 "type": "number",2342 "description": "Stores the coupon value as shown in the cart"2343 },2344 "tax_collected_at_source": {2345 "type": "number",2346 "description": "The tax amount collected at the source of income or transaction"2347 },2348 "promotion_effective_discount": {2349 "type": "number",2350 "description": "Effective promotion discount including promotions given by seller and Platform"2351 },2352 "fynd_promotion_effective_discount": {2353 "type": "number",2354 "description": "Promotion discount given by Platform/fynd"2355 },2356 "seller_promotion_effective_discount": {2357 "type": "number",2358 "description": "Promotion discount given by the seller"2359 },2360 "cn_refund_amount": {2361 "type": "number",2362 "description": "Amount to be refunded through credit note"2363 },2364 "gift_price": {2365 "type": "number",2366 "description": "Gift card amount used"2367 },2368 "amount_paid_roundoff": {2369 "type": "number",2370 "description": "Amount paid rounded off"2371 },2372 "loyalty_discount": {2373 "type": "number",2374 "description": "Amount reduced from the payable price when the customer applies loyalty program points while placing the order"2375 }2376 },2377 "required": [2378 "amount_paid",2379 "refund_amount",2380 "price_marked",2381 "cod_charges",2382 "discount",2383 "cashback_applied",2384 "delivery_charge",2385 "fynd_credits",2386 "cashback",2387 "price_effective",2388 "refund_credit",2389 "value_of_good",2390 "coupon_value",2391 "tax_collected_at_source",2392 "promotion_effective_discount",2393 "fynd_promotion_effective_discount",2394 "seller_promotion_effective_discount",2395 "cn_refund_amount",2396 "gift_price"2397 ]2398 },2399 "payments": {2400 "type": "object",2401 "description": "Object containing payment mode and payment breakup",2402 "properties": {2403 "id": {2404 "type": "number",2405 "description": "Unique identifier for the payment mode"2406 },2407 "mode": {2408 "type": "string",2409 "description": "Type or category of the payment mode (e.g., PP, COD)"2410 },2411 "logo": {2412 "type": "string",2413 "description": "URL or path to the logo/icon representing the payment mode"2414 },2415 "display_name": {2416 "type": "string",2417 "description": "Name or label used to display the payment mode"2418 },2419 "display_priority": {2420 "type": "number",2421 "description": "Priority order for displaying the payment mode"2422 },2423 "source": {2424 "type": "string",2425 "description": "Merchant of the payment mode (e.g., PartnerPay, JioPp)"2426 },2427 "is_active": {2428 "type": "boolean",2429 "description": "Boolean indicating whether the payment mode is currently active"2430 }2431 },2432 "required": [2433 "id",2434 "mode",2435 "logo",2436 "display_name",2437 "display_priority",2438 "source",2439 "is_active"2440 ]2441 },2442 "affiliate_details": {2443 "type": "object",2444 "description": "Application related details like config, order_id, shipment id",2445 "properties": {2446 "id": {2447 "type": [2448 "string",2449 "number"2450 ],2451 "description": "Identifier for the application, can be application_id or extension_id"2452 },2453 "affiliate_bag_id": {2454 "type": "string",2455 "description": "Identifier assigned by the application for the bag"2456 },2457 "affiliate_order_id": {2458 "type": "string",2459 "description": "Identifier of the order assigned by the application"2460 },2461 "company_affiliate_tag": {2462 "type": "string",2463 "description": "Tag associated with the bag from the application's company"2464 },2465 "affiliate_id": {2466 "type": "string",2467 "description": "Identifier for the application, can be application_id or extension_id"2468 },2469 "affiliate_shipment_id": {2470 "type": "string",2471 "description": "Identifier of the shipment assigned by the application"2472 },2473 "affiliate_store_id": {2474 "type": "string",2475 "description": "Identifier of the store assigned by the application"2476 },2477 "pdf_links": {2478 "type": "object",2479 "description": "PDF Links pushed by the application or extension",2480 "properties": {2481 "label_type": {2482 "type": "string",2483 "description": "Label type - external"2484 },2485 "invoice_type": {2486 "type": "string",2487 "description": "Invoice type - external"2488 },2489 "label": {2490 "type": "string",2491 "description": "Label URL provided by the application or extension"2492 },2493 "invoice": {2494 "type": "string",2495 "description": "Invoice URL provided by the application or extension"2496 }2497 },2498 "required": [2499 "label_type",2500 "invoice_type"2501 ]2502 },2503 "config": {2504 "type": "object",2505 "description": "Application configuration details",2506 "properties": {2507 "id": {2508 "type": [2509 "string",2510 "number"2511 ],2512 "description": "Identifier for the application, can be application_id or extension_id"2513 },2514 "name": {2515 "type": "string",2516 "description": "Application name"2517 },2518 "token": {2519 "type": [2520 "null",2521 "string"2522 ],2523 "description": "Application token - deprecated"2524 },2525 "dp_assignment": {2526 "type": "boolean",2527 "description": "Flag indicating whether auto DP assignment should happen from system"2528 },2529 "app_company_id": {2530 "type": [2531 "number",2532 "null",2533 "string"2534 ],2535 "description": "ID of the company from which order was placed"2536 },2537 "article_assignment": {2538 "description": "The article assignment settings",2539 "type": "object",2540 "properties": {2541 "strategy": {2542 "type": "string",2543 "enum": [2544 "optimal",2545 "low-price"2546 ]2547 },2548 "level": {2549 "type": "string",2550 "enum": [2551 "multi-companies",2552 "single-company",2553 "single-store"2554 ]2555 }2556 },2557 "required": []2558 },2559 "force_reassignment": {2560 "type": "boolean",2561 "description": "Indicates whether force reassignment is enabled"2562 },2563 "sales_channel_logo": {2564 "type": "string",2565 "description": "Logo URL of the application to which order belongs"2566 },2567 "ordering_channel_logo": {2568 "type": "string",2569 "description": "Logo URL of the ordering channel"2570 },2571 "post_order_reassignment": {2572 "type": "boolean",2573 "description": "Indicates whether post-order reassignment is enabled"2574 }2575 }2576 }2577 },2578 "required": [2579 "id",2580 "affiliate_bag_id",2581 "affiliate_order_id",2582 "company_affiliate_tag",2583 "affiliate_id",2584 "affiliate_shipment_id",2585 "affiliate_store_id",2586 "pdf_links",2587 "config"2588 ]2589 },2590 "dp_details": {2591 "type": "object",2592 "description": "Delivery Partner details",2593 "properties": {2594 "id": {2595 "type": [2596 "string",2597 "number",2598 "null"2599 ],2600 "description": "Unique identifier for the delivery partner"2601 },2602 "name": {2603 "type": [2604 "string",2605 "null"2606 ],2607 "description": "Name of the delivery partner"2608 },2609 "awb_no": {2610 "type": [2611 "string",2612 "null"2613 ],2614 "description": "Airway Bill (AWB) number associated with the delivery"2615 },2616 "eway_bill_id": {2617 "type": [2618 "string",2619 "null"2620 ],2621 "description": "Electronic Way Bill (E-way Bill) ID for the delivery"2622 },2623 "track_url": {2624 "type": [2625 "string",2626 "null"2627 ],2628 "description": "URL to track the delivery status or shipment details"2629 },2630 "gst_tag": {2631 "type": [2632 "string",2633 "null"2634 ],2635 "description": "GST tag of the shipment"2636 },2637 "extension_id": {2638 "type": [2639 "string",2640 "null"2641 ],2642 "description": "Unique Identifier of Courier partner Extension"2643 },2644 "scheme_id": {2645 "type": [2646 "string",2647 "null"2648 ],2649 "description": "Unique identifier of a Courier partner scheme"2650 },2651 "courier_partner_slug": {2652 "type": [2653 "string",2654 "null"2655 ],2656 "description": "Unique identifier containing extension_id and scheme_id"2657 }2658 },2659 "required": [2660 "id",2661 "name",2662 "awb_no",2663 "eway_bill_id",2664 "track_url",2665 "gst_tag",2666 "extension_id",2667 "scheme_id",2668 "courier_partner_slug"2669 ]2670 },2671 "rto_address": {2672 "type": "object",2673 "description": "The address to which shipment should be delivered in case of RTO",2674 "properties": {2675 "company_id": {2676 "type": "number",2677 "description": "ID of the company fulfilling the shipment"2678 },2679 "id": {2680 "type": "number",2681 "description": "ID of the store where RTO should happen"2682 },2683 "name": {2684 "type": "string",2685 "description": "A string representing the store's name"2686 },2687 "store_address_json": {2688 "type": "object",2689 "description": "Store address details",2690 "properties": {2691 "version": {2692 "type": "string",2693 "description": "Address version, to be deprecated"2694 },2695 "contact_person": {2696 "type": "string",2697 "description": "Name of the contact person associated with the address"2698 },2699 "address": {2700 "type": "string",2701 "description": "\"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""2702 },2703 "address1": {2704 "type": "string",2705 "description": "\"A string representing the first line of the address, typically containing street or building information\""2706 },2707 "address2": {2708 "type": "string",2709 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""2710 },2711 "name": {2712 "type": "string",2713 "description": "A string representing the store's name"2714 },2715 "area": {2716 "type": "string",2717 "description": "A string specifying the locality or area associated with the address"2718 },2719 "area_code": {2720 "type": "string",2721 "x-not-enum": true,2722 "description": "Area code of the address"2723 },2724 "area_code_slug": {2725 "type": "string",2726 "description": "Unique identifier or slug for the area code associated with the address"2727 },2728 "landmark": {2729 "type": "string",2730 "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""2731 },2732 "city": {2733 "type": "string",2734 "description": "A string denoting the city or municipality of the address"2735 },2736 "state": {2737 "type": "string",2738 "description": "A string indicating the state or province of the address"2739 },2740 "country": {2741 "type": "string",2742 "description": "A string indicating the country of the address"2743 },2744 "pincode": {2745 "type": "string",2746 "description": "A string indicating the postal code or PIN code of the address area"2747 },2748 "longitude": {2749 "type": [2750 "number",2751 "string"2752 ],2753 "description": "The longitude of the address"2754 },2755 "sector": {2756 "type": "string",2757 "description": "A string specifying the sector or district of the address if applicable"2758 },2759 "latitude": {2760 "type": [2761 "number",2762 "string"2763 ],2764 "description": "The latitude of the address"2765 },2766 "phone": {2767 "type": "string",2768 "description": "Mobile phone number of recipient associated with the address"2769 },2770 "email": {2771 "type": "string",2772 "description": "Email of the recipient associated with the address"2773 },2774 "address_type": {2775 "type": "string",2776 "x-not-enum": true,2777 "description": "Type of address (e.g., home, office, registered)"2778 },2779 "address_category": {2780 "type": "string",2781 "x-not-enum": true,2782 "description": "Category or classification of the address"2783 },2784 "created_at": {2785 "type": "string",2786 "format": "date-time",2787 "description": "Date and time when the address was created"2788 },2789 "updated_at": {2790 "type": "string",2791 "format": "date-time",2792 "description": "Date and time when the address was last updated"2793 },2794 "country_phone_code": {2795 "type": [2796 "string",2797 "null"2798 ],2799 "x-not-enum": true,2800 "description": "Phone code for the country of the address"2801 },2802 "country_iso_code": {2803 "type": "string",2804 "x-not-enum": true,2805 "description": "ISO code representing the country of the address"2806 },2807 "country_code": {2808 "type": "string",2809 "x-not-enum": true,2810 "description": "ISO code representing the country of the address"2811 },2812 "display_address": {2813 "type": "string",2814 "description": "Formatted display version of the address"2815 }2816 }2817 },2818 "code": {2819 "type": "string",2820 "description": "Alphanumeric code representing the store"2821 },2822 "location_type": {2823 "type": "string",2824 "x-not-enum": true,2825 "description": "Type of location e.g., warehouse, high_street"2826 },2827 "address1": {2828 "type": "string",2829 "description": "\"A string representing the first line of the address, typically containing street or building information\""2830 },2831 "address2": {2832 "type": "string",2833 "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""2834 },2835 "display_address": {2836 "type": "string",2837 "description": "Formatted display version of the address"2838 },2839 "city": {2840 "type": "string",2841 "description": "A string denoting the city or municipality of the address"2842 },2843 "state": {2844 "type": "string",2845 "description": "A string indicating the state or province of the address"2846 },2847 "sector": {2848 "type": "string",2849 "description": "A string specifying the sector or district of the address if applicable"2850 },2851 "country": {2852 "type": "string",2853 "description": "A string indicating the country of the address"2854 },2855 "pincode": {2856 "type": "string",2857 "description": "A string indicating the postal code or PIN code of the address area"2858 },2859 "store_email": {2860 "type": "string",2861 "description": "Email of the recipient associated with the store"2862 },2863 "contact_person": {2864 "type": "string",2865 "description": "Name of the contact person associated with the address"2866 },2867 "phone": {2868 "type": "string",2869 "description": "Mobile phone number of recipient associated with the address"2870 }2871 },2872 "required": [2873 "company_id",2874 "id",2875 "name",2876 "store_address_json",2877 "code",2878 "location_type",2879 "address1",2880 "address2",2881 "display_address",2882 "city",2883 "state",2884 "sector",2885 "country",2886 "pincode",2887 "store_email",2888 "contact_person",2889 "phone"2890 ]2891 },2892 "weight": {2893 "type": "object",2894 "description": "Shipment weight",2895 "properties": {2896 "value": {2897 "type": "number"2898 },2899 "unit": {2900 "type": "string"2901 }2902 },2903 "required": [2904 "value",2905 "unit"2906 ]2907 },2908 "shipment_gst": {2909 "type": "object",2910 "description": "GST details associated with the shipment",2911 "properties": {2912 "value_of_good": {2913 "type": "number",2914 "description": "Effective selling price - Product GST Amount"2915 },2916 "gst_fee": {2917 "type": "number",2918 "description": "The fee associated with Goods and Services Tax (GST) for a product or service"2919 },2920 "brand_calculated_amount": {2921 "type": "number",2922 "description": "Effective selling price - Brand's additional discounts"2923 },2924 "tax_collected_at_source": {2925 "type": "number",2926 "description": "The tax amount collected at the source of income or transaction"2927 },2928 "gstin_code": {2929 "type": [2930 "string",2931 "null"2932 ],2933 "x-not-enum": true,2934 "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"2935 }2936 },2937 "required": [2938 "value_of_good",2939 "gst_fee",2940 "brand_calculated_amount",2941 "tax_collected_at_source",2942 "gstin_code"2943 ]2944 },2945 "store_invoice_id": {2946 "type": [2947 "string",2948 "null"2949 ],2950 "description": "Invoice ID attached to the shipment"2951 },2952 "credit_note_id": {2953 "type": [2954 "string",2955 "null"2956 ],2957 "description": "Credit Note ID attached to the shipment"2958 },2959 "order_created": {2960 "type": "string",2961 "description": "Order creation timestamp"2962 },2963 "payment_methods": {2964 "type": "object",2965 "description": "\"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details.\""2966 },2967 "payment_info": {2968 "type": "array",2969 "description": "\"Array of object containing payment methods used for placing an order.\"",2970 "items": {}2971 },2972 "order": {2973 "type": "object",2974 "description": "Order level details",2975 "properties": {2976 "ordering_channel": {2977 "type": "string",2978 "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."2979 },2980 "ordering_source": {2981 "type": "string",2982 "nullable": true,2983 "description": "To uniquely identify the source through which order has been placed."2984 },2985 "affiliate_order_date": {2986 "type": [2987 "string",2988 "null"2989 ],2990 "format": "date-time",2991 "description": "Order creation timestamp at application/extension end"2992 },2993 "affiliate_order_id": {2994 "type": "string",2995 "description": "Identifier of the order assigned by the application"2996 },2997 "fynd_order_id": {2998 "type": "string",2999 "description": "System generated unique identifier of the order"3000 },3001 "mode_of_payment": {3002 "type": "string",3003 "description": "Unique identifier associated with the payment mode"3004 },3005 "source": {3006 "type": "string",3007 "description": "Ordering source eg. affiliate, fynd"3008 },3009 "total_order_value": {3010 "type": "number",3011 "description": "Total order value"3012 },3013 "collect_by": {3014 "type": "string",3015 "description": "Whomsoever collected the money"3016 },3017 "refund_by": {3018 "type": "string",3019 "description": "Whomsoever will refund the money"3020 },3021 "order_value": {3022 "type": "number",3023 "description": "Value of the order"3024 },3025 "loyalty_discount_details": {3026 "type": "object",3027 "properties": {3028 "discount": {3029 "type": "number",3030 "description": "Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed"3031 },3032 "ownership": {3033 "type": "string",3034 "description": "Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace"3035 },3036 "is_applied": {3037 "type": "boolean",3038 "description": "Specifies whether the loyalty discount has been applied to the order"3039 }3040 },3041 "description": "Applied loyalty discount information"3042 }3043 },3044 "required": [3045 "ordering_channel",3046 "affiliate_order_date",3047 "affiliate_order_id",3048 "fynd_order_id",3049 "mode_of_payment",3050 "source",3051 "total_order_value",3052 "collect_by",3053 "refund_by",3054 "order_value"3055 ]3056 },3057 "order_source": {3058 "type": "string",3059 "description": "Ordering source eg. affiliate, fynd"3060 },3061 "journey_type": {3062 "type": [3063 "string",3064 "null"3065 ],3066 "description": "Journey type forward or return"3067 },3068 "einvoice_info": {3069 "type": "object",3070 "description": "Einvoice info if e-invoice is applicable",3071 "properties": {3072 "credit_note": {3073 "description": "Details of the reverse credit note einvoice",3074 "type": "object",3075 "properties": {3076 "ack_dt": {3077 "type": "string",3078 "description": "Date and time when the e-invoice acknowledgment was received"3079 },3080 "ack_no": {3081 "type": "string",3082 "description": "Acknowledgment number assigned to the e-invoice upon successful submission"3083 },3084 "irn": {3085 "type": "string",3086 "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"3087 },3088 "signed_invoice": {3089 "type": "string",3090 "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"3091 },3092 "signed_qr_code": {3093 "x-not-enum": true,3094 "type": "string",3095 "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"3096 },3097 "message": {3098 "type": "array",3099 "description": "Error Message received from JioGSt",3100 "items": {3101 "type": "object",3102 "properties": {3103 "ErrorCode": {3104 "type": [3105 "string",3106 "null"3107 ]3108 },3109 "ErrorMessage": {3110 "type": [3111 "string",3112 "null"3113 ]3114 }3115 }3116 }3117 }3118 }3119 },3120 "invoice": {3121 "description": "Details of the forward invoice einvoice",3122 "type": "object",3123 "properties": {3124 "ack_dt": {3125 "type": "string",3126 "description": "Date and time when the e-invoice acknowledgment was received"3127 },3128 "ack_no": {3129 "type": "string",3130 "description": "Acknowledgment number assigned to the e-invoice upon successful submission"3131 },3132 "irn": {3133 "type": "string",3134 "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"3135 },3136 "signed_invoice": {3137 "type": "string",3138 "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"3139 },3140 "signed_qr_code": {3141 "x-not-enum": true,3142 "type": "string",3143 "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"3144 },3145 "message": {3146 "type": "array",3147 "description": "Error Message received from JioGSt",3148 "items": {3149 "type": "object",3150 "properties": {3151 "ErrorCode": {3152 "type": [3153 "string",3154 "null"3155 ]3156 },3157 "ErrorMessage": {3158 "type": [3159 "string",3160 "null"3161 ]3162 }3163 }3164 }3165 }3166 }3167 }3168 },3169 "required": []3170 },3171 "lock_status": {3172 "type": "boolean",3173 "description": "Lock status of the shipment"3174 },3175 "original_bag_list": {3176 "type": "array",3177 "items": {3178 "type": "number"3179 },3180 "description": "List of Bag ids when the order was created"3181 },3182 "shipment_update_time": {3183 "type": "number",3184 "description": "Last shipment update time"3185 },3186 "previous_shipment_id": {3187 "type": [3188 "string",3189 "null"3190 ],3191 "description": "\"ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition\""3192 },3193 "fyndstore_emp": {3194 "type": "object",3195 "description": "Fynd store employee details",3196 "properties": {},3197 "required": []3198 },3199 "ordering_store": {3200 "description": "Store details from which order was placed in case of StoreOS",3201 "required": [],3202 "type": "object",3203 "properties": {3204 "id": {3205 "type": "number",3206 "description": "Unique identifier for the store."3207 },3208 "code": {3209 "type": "string",3210 "description": "Alphanumeric code representing the store."3211 },3212 "name": {3213 "type": "string",3214 "description": "Name of the store."3215 },3216 "address": {3217 "type": "string",3218 "description": "Physical address of the store."3219 },3220 "state": {3221 "type": "string",3222 "description": "State where the store is located."3223 },3224 "city": {3225 "type": "string",3226 "description": "City where the store is located."3227 },3228 "pincode": {3229 "type": "string",3230 "description": "Postal code (pincode) of the store's location."3231 },3232 "country": {3233 "type": "string",3234 "description": "Country where the store is situated."3235 },3236 "phone": {3237 "type": "string",3238 "description": "Contact phone number for the store."3239 },3240 "fulfillment_channel": {3241 "type": "string",3242 "description": "Type of fulfillment channel used by the store."3243 },3244 "location_type": {3245 "type": "string",3246 "enum": [3247 "high_street",3248 "mall",3249 "store",3250 "warehouse"3251 ],3252 "description": "Type of location e.g., warehouse, high_street"3253 },3254 "company_id": {3255 "type": "number",3256 "description": "Identifier of the company responsible for fulfilling shipments from this store"3257 },3258 "is_active": {3259 "type": "boolean",3260 "description": "Boolean indicating whether the store is currently active"3261 },3262 "tags": {3263 "type": "array",3264 "items": {3265 "type": "string"3266 },3267 "description": "Array of tags associated with the store"3268 }3269 }3270 },3271 "coupon": {3272 "type": "object",3273 "description": "Coupon related details",3274 "properties": {},3275 "required": []3276 },3277 "cart_info": {3278 "type": "object",3279 "description": "Cart related information",3280 "properties": {3281 "cart_id": {3282 "type": "string",3283 "description": "The unique identifier of the cart"3284 },3285 "cart_uid": {3286 "type": "number",3287 "description": "UID associated with the cart"3288 }3289 },3290 "required": [3291 "cart_id",3292 "cart_uid"3293 ]3294 }3295 },3296 "required": [3297 "status",3298 "shipment_status",3299 "application_id",3300 "shipment_id",3301 "company_id",3302 "app_company_id",3303 "order_id",3304 "merchant_id",3305 "user",3306 "delivery_address",3307 "billing_address",3308 "delivery_partner_details",3309 "bags",3310 "bag_status_history",3311 "fulfilling_store",3312 "prices",3313 "payments",3314 "affiliate_details",3315 "dp_details",3316 "rto_address",3317 "weight",3318 "shipment_gst",3319 "store_invoice_id",3320 "credit_note_id",3321 "order_created",3322 "payment_methods",3323 "payment_info",3324 "order",3325 "order_source",3326 "journey_type",3327 "einvoice_info",3328 "lock_status",3329 "original_bag_list",3330 "shipment_update_time",3331 "previous_shipment_id",3332 "fyndstore_emp",3333 "ordering_store",3334 "coupon",3335 "cart_info"3336 ]3337 }3338 },3339 "required": [3340 "shipment"3341 ]3342 }3343 }3344}
Payload Example
1{2 "event": {3 "trace_id": [4 "0000000000000000fcb9acdea07f86c1"5 ],6 "name": "shipment",7 "type": "data_update",8 "version": "1",9 "created_timestamp": 1711863902491,10 "id": "QsOwO98GEZml5dGw/vScF+Z+xHnDdgfSqRVjMMY/N/k=",11 "category": "application"12 },13 "company_id": 46,14 "application_id": "614b42d1ea943427b5f46d1e",15 "contains": [16 "shipment"17 ],18 "payload": {19 "shipment": {20 "status": "ready_for_dp_assignment",21 "shipment_status": {22 "bag_list": [23 "33844742",24 "33844743"25 ],26 "id": 163969392,27 "updated_ts": "2024-03-31T05:45:02Z",28 "shipment_id": "17118062289491816415",29 "created_at": "2024-03-31T11:15:02+00:00",30 "created_ts": "2024-03-31T05:45:02Z",31 "meta": {32 "request_meta": {},33 "estimated_sla_ts": "2024-04-01T13:43:48Z",34 "estimated_sla_time": "2024-04-01T19:13:48+05:30",35 "state_manager_used": "entity"36 },37 "status": "ready_for_dp_assignment",38 "current_shipment_status": "ready_for_dp_assignment",39 "status_created_at": "2024-03-31T11:15:02+00:00"40 },41 "application_id": "614b42d1ea943427b5f46d1e",42 "shipment_id": "17118062289491816415",43 "company_id": 46,44 "app_company_id": 46,45 "order_id": "FY660817140E6E656DB9",46 "merchant_id": "",47 "user": {48 "gender": null,49 "email": "test@example.com",50 "id": null,51 "mongo_user_id": null,52 "external_customer_id": "",53 "first_name": "",54 "user_oid": null,55 "meta": null,56 "last_name": "",57 "mobile": null,58 "is_anonymous_user": true59 },60 "delivery_address": {61 "area": "test area",62 "city": "South Delhi",63 "meta": {64 "area_code": "110017",65 "area_code_slug": "pincode"66 },67 "name": "test name",68 "email": "test@example.com",69 "phone": "1111111111",70 "state": "Delhi",71 "address": "test address",72 "country": "India",73 "pincode": "110017",74 "user_id": null,75 "version": "1.0",76 "address1": "test address",77 "address2": "",78 "landmark": "",79 "latitude": 0,80 "area_code": "110017",81 "longitude": 0,82 "created_at": "2024-03-30T19:13:48+00:00",83 "updated_at": "2024-03-30T19:13:48+00:00",84 "address_type": "home",85 "country_code": "IN",86 "geo_location": {},87 "area_code_slug": "pincode",88 "contact_person": "test user",89 "display_address": "test address",90 "address_category": "",91 "country_iso_code": "IN",92 "country_phone_code": null93 },94 "billing_address": {95 "area": "test area",96 "city": "Delhi",97 "meta": {98 "area_code": "110017",99 "area_code_slug": "pincode"100 },101 "name": "test user",102 "email": "test@example.com",103 "phone": "1111111111",104 "state": "DELHI",105 "address": "test address",106 "country": "India",107 "pincode": "110017",108 "user_id": null,109 "version": "1.0",110 "address1": "test address",111 "address2": "",112 "landmark": "",113 "latitude": 0,114 "area_code": "110017",115 "longitude": 0,116 "created_at": "2024-03-30 19:13:48",117 "updated_at": "2024-03-30 19:13:48",118 "address_type": "home",119 "country_code": "IN",120 "geo_location": {},121 "area_code_slug": "pincode",122 "contact_person": "dummy user",123 "display_address": "test address",124 "address_category": "",125 "country_iso_code": "IN",126 "country_phone_code": null127 },128 "delivery_partner_details": {129 "id": null,130 "name": null,131 "awb_no": null,132 "eway_bill_id": null,133 "track_url": null,134 "gst_tag": "sgst",135 "extension_id": null,136 "scheme_id": null,137 "courier_partner_slug": null138 },139 "bags": [140 {141 "financial_breakup": [142 {143 "brand_calculated_amount": 1397,144 "discount": 1398,145 "gst_fee": 149.68,146 "gst_tax_percentage": 12,147 "gst_tag": "IGST",148 "hsn_code": "62111200",149 "identifiers": {150 "alu": "000000410255726014"151 },152 "price_marked": 2795,153 "tax_collected_at_source": 0,154 "tcs_percentage": 0,155 "total_units": 1,156 "value_of_good": 1247.32,157 "item_name": "Scallop Goddess Plunge PU",158 "size": "32A"159 }160 ],161 "entity_type": "bag",162 "item": {163 "gender": null,164 "id": 1186480,165 "color": null,166 "webstore_product_url": null,167 "l2_category_id": 24,168 "branch_url": "https://go.fyndi.ng/zNzR6WNcx3",169 "name": "Scallop Goddess Plunge PU",170 "brand": "Hunkemoller",171 "can_cancel": true,172 "brand_id": 356,173 "code": "166801NERO",174 "slug_key": "hunkemoller-black-bikini-scallop-goddess-plunge-top-1186480-fdf824",175 "l1_category_id": 442,176 "l2_category": [177 "Beachwear & Swimwear"178 ],179 "meta": {180 "tags": [181 "Swimwear",182 "B2B3"183 ],184 "departments": [185 21186 ]187 },188 "last_updated_at": "2024-03-30T19:13:49+00:00",189 "attributes": {190 "name": "Scallop Goddess Plunge PU",191 "color": "Black",192 "gender": [193 "Women"194 ],195 "season": "SS20",196 "pattern": "Solid",197 "material": "95% Polyamide, 5% Elastane",198 "occasion": "Casual",199 "essential": "No",200 "brand_name": "Hunkemoller",201 "net-quantity": "1 N",202 "marketer-name": "Reliance Brands Limited",203 "primary_color": "Black",204 "marketer-address": "test address",205 "primary_material": "Polyester",206 "primary_color_hex": "000000",207 "primary-colour-hex-code": "000000",208 "media": []209 },210 "can_return": true,211 "l3_category": 1370,212 "l3_category_name": "Beachwear Bikini Tops",213 "l1_category": [214 "Clothing"215 ],216 "department_id": 21,217 "size": "32A",218 "image": [219 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/Jc1KtK-mUOG-410255726003_1.jpg",220 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/CDcXFczdYb8-410255726003_2.jpg",221 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/cgemmtRjD-410255726003_3.jpg",222 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/YIs0m4K3Px-410255726003_4.jpg",223 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/8FaVpjBLcz-410255726003_5.jpg",224 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/_vM4sgtYkL-410255726003_6.jpg"225 ]226 },227 "brand": {228 "credit_note_allowed": false,229 "brand_name": "Hunkemoller",230 "id": 356,231 "modified_on": "2023-06-20T18:49:25+00:00",232 "is_virtual_invoice": false,233 "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/media/logo/brand/original/1129_43ac065d3d9f43c6b5adddcb33294e77.jpg",234 "created_on": "2017-02-08T13:40:44+00:00"235 },236 "bag_id": 33844742,237 "article": {238 "identifiers": {239 "alu": "000000410255726014"240 },241 "esp_modified": false,242 "size": "32A",243 "code": "",244 "raw_meta": null,245 "set": {},246 "is_set": false,247 "seller_identifier": "000000410255726014",248 "return_config": {249 "time": 30,250 "unit": "days",251 "returnable": true252 },253 "_id": "630de4e5ea54210bdddf2882",254 "uid": "630de4e5ea54210bdddf2882",255 "child_details": {},256 "dimensions": {257 "unit": "cm",258 "width": 17,259 "height": 8,260 "length": 27.5,261 "is_default": true262 },263 "weight": {264 "unit": "gram",265 "shipping": 100,266 "is_default": true267 },268 "currency": {269 "code": "INR",270 "rate": 1271 },272 "expiration_date": "9998-01-30 23:59:00"273 },274 "current_operational_status": {275 "id": 216808130,276 "updated_ts": "2024-03-31T05:45:02Z",277 "kafka_sync": false,278 "shipment_id": "17118062289491816415",279 "state_type": "operational",280 "state_id": 113,281 "updated_at": "2024-03-31T11:15:02+00:00",282 "bag_id": 33844742,283 "created_at": "2024-03-31T11:15:02+00:00",284 "delivery_awb_number": null,285 "delivery_partner_id": null,286 "created_ts": "2024-03-31T05:45:02Z",287 "store_id": 14406,288 "status": "ready_for_dp_assignment",289 "bag_state_mapper": {290 "journey_type": "forward",291 "app_display_name": "Ready For Dp Assignment",292 "state_type": "operational",293 "app_state_name": "ready_for_dp_assignment",294 "name": "ready_for_dp_assignment",295 "app_facing": false,296 "id": 113,297 "display_name": "Ready For Dp Assignment",298 "notify_customer": false,299 "is_active": true300 },301 "reasons": [],302 "action_user": {}303 },304 "affiliate_bag_details": {305 "affiliate_bag_id": "33844742",306 "affiliate_order_id": "251640",307 "affiliate_meta": {308 "fynd": {309 "fulfilment_identifier": "pulse",310 "fulfilment_identifiers_list": [311 "pulse"312 ]313 },314 "channel_shipment_id": null,315 "channel_order_id": null,316 "due_date": null,317 "is_priority": false,318 "box_type": null,319 "coupon_code": "",320 "size_level_total_qty": 1,321 "loyalty_discount": 0,322 "employee_discount": 0323 },324 "loyalty_discount": 0,325 "employee_discount": 0326 },327 "payment_methods": {328 "PP": {329 "amount": 1397330 }331 },332 "quantity": 1,333 "prices": {334 "price_effective": 1397,335 "discount": 1398,336 "amount_paid": 1397,337 "coupon_effective_discount": 0,338 "delivery_charge": 0,339 "fynd_credits": 0,340 "cod_charges": 0,341 "refund_credit": 0,342 "cashback": 0,343 "refund_amount": 1397,344 "added_to_fynd_cash": false,345 "cashback_applied": 0,346 "gst_tax_percentage": 12,347 "value_of_good": 1247.32,348 "price_marked": 2795,349 "transfer_price": 0,350 "brand_calculated_amount": 1397,351 "tax_collected_at_source": 0,352 "tcs_percentage": 0,353 "promotion_effective_discount": 0,354 "gift_price": 0,355 "coupon_value": 0,356 "seller_promotion_effective_discount": 0,357 "fynd_promotion_effective_discount": 0,358 "amount_paid_roundoff": 1397359 },360 "order_created": "2024-03-30T19:13:49+00:00",361 "gst_details": {362 "gstin_code": "06AADCR7395F1Z4",363 "gst_tag": "IGST",364 "hsn_code": "62111200",365 "value_of_good": 1247.32,366 "gst_tax_percentage": 12,367 "is_default_hsn_code": false,368 "brand_calculated_amount": 1397,369 "tax_collected_at_source": 0,370 "hsn_code_id": "627783925e4c6fdbc8be40c7",371 "gst_fee": 149.68,372 "igst_tax_percentage": 12,373 "sgst_tax_percentage": 0,374 "cgst_tax_percentage": 0,375 "igst_gst_fee": 149.68,376 "cgst_gst_fee": "0",377 "sgst_gst_fee": "0",378 "tax_rule_id": "627783925e4c6fdbc8be40c7"379 },380 "line_number": 1,381 "applied_promos": [],382 "taxes": [383 {384 "name": "GST",385 "rate": 0.09,386 "taxable_amount": 231.19,387 "tax_amount": 20.81388 }389 ],390 "meta": {391 "group_id": "",392 "gift_card": {393 "gift_price": 0,394 "display_text": "",395 "is_gift_applied": false396 },397 "extra_meta": {398 "price_marked": "2795.00",399 "price_effective": 1397400 },401 "_custom_json": {402 "_display": []403 },404 "docket_number": "171180622894918164151",405 "partial_can_ret": false,406 "country_of_origin": "China",407 "parent_docket_number": "171180622894918164151",408 "product_discount_applied": {409 "_id": "65f2c7c5352864fccbd0b7b5",410 "job_id": "65f2c7aba17754320ad4f33c",411 "app_ids": [412 "614b42d1ea943427b5f46d1e"413 ],414 "item_id": 1186480,415 "discount": [416 {417 "value": 50,418 "min_items": 1419 }420 ],421 "zone_ids": [],422 "abandoned": false,423 "brand_ids": [424 356425 ],426 "company_id": 46,427 "created_on": "2024-03-14T13:49:02.698000",428 "modified_on": "2024-03-14T13:49:02.698000",429 "discount_job": {430 "_id": "65f2c7aba17754320ad4f33c",431 "meta": {432 "triggerhappyEndJob": "65f3003562b57f4a495ca54f",433 "triggerhappyStartJob": "65f3003562b57f779c5ca54e"434 },435 "name": "HKM BRA PARTY FLAT 50% OFF",436 "value": null,437 "app_ids": [438 "614b42d1ea943427b5f46d1e"439 ],440 "job_type": "app|brand|inventory",441 "validity": {442 "end": "2024-04-29T18:30:00",443 "start": "2024-03-14T18:50:00"444 },445 "zone_ids": [],446 "brand_ids": [447 356448 ],449 "file_path": "/company/46/self/documents/product-import/free/original/KlA4KBqfk-50percent-off.xlsx",450 "is_active": true,451 "company_id": 46,452 "created_by": {453 "user_id": "23542762",454 "username": "test_example_com_12345"455 },456 "created_on": "2024-03-14T09:47:23.981000",457 "modified_by": {458 "user_id": "23542762",459 "username": "test_example_com_12345"460 },461 "modified_on": "2024-03-14T18:50:00.061000",462 "discount_meta": {463 "hours": 0,464 "timer": false,465 "minutes": 0466 },467 "discount_type": "percentage",468 "discount_level": "application"469 },470 "discount_meta": {471 "end": "2024-04-29T18:30:00Z",472 "start": "2024-03-14T18:50:00Z",473 "timer": false474 },475 "discount_type": "percentage",476 "seller_identifier": "000000410255726014"477 },478 "delivery_charges_hsn_code": "996819",479 "multi_quantity_bag_enabled": false480 }481 },482 {483 "financial_breakup": [484 {485 "brand_calculated_amount": 697,486 "discount": 698,487 "gst_fee": 33.19,488 "gst_tax_percentage": 5,489 "gst_tag": "IGST",490 "hsn_code": "61124100",491 "identifiers": {492 "alu": "000000410255725001"493 },494 "price_marked": 1395,495 "tax_collected_at_source": 0,496 "tcs_percentage": 0,497 "total_units": 1,498 "value_of_good": 663.81,499 "item_name": "Black Scallop Goddess Cheeky Tanga Bikini",500 "size": "XS"501 }502 ],503 "entity_type": "bag",504 "item": {505 "gender": null,506 "id": 1182446,507 "color": null,508 "webstore_product_url": null,509 "l2_category_id": 24,510 "branch_url": "https://go.fyndi.ng/6nG85zkFm3",511 "name": "Black Scallop Goddess Cheeky Tanga Bikini",512 "brand": "Hunkemoller",513 "can_cancel": true,514 "brand_id": 356,515 "code": "166804NERO",516 "slug_key": "hunkemoller-black-scallop-goddess-cheeky-tanga-bikini-1182446-d314d7",517 "l1_category_id": 442,518 "l2_category": [519 "Beachwear & Swimwear"520 ],521 "meta": {522 "tags": [523 "Swimwear",524 "B2B3"525 ],526 "departments": [527 21528 ]529 },530 "last_updated_at": "2024-03-30T19:13:49+00:00",531 "attributes": {532 "name": "Black Scallop Goddess Cheeky Tanga Bikini",533 "color": "Black",534 "gender": [535 "Women"536 ],537 "season": "SS20",538 "pattern": "Solid",539 "material": "95% Polyamide, 5% Elastane",540 "occasion": "Casual",541 "essential": "No",542 "brand_name": "Hunkemoller",543 "net-quantity": "1 N",544 "marketer-name": "Reliance Brands Limited",545 "primary_color": "Black",546 "marketer-address": "test address",547 "primary_material": "Nylon",548 "primary_color_hex": "000000",549 "primary-colour-hex-code": "000000",550 "media": []551 },552 "can_return": true,553 "l3_category": 333,554 "l3_category_name": "Bikinis",555 "l1_category": [556 "Clothing"557 ],558 "department_id": 21,559 "size": "XS",560 "image": [561 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/Tb8em-hRR-E-410255725001_1.jpg",562 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/NmHExkPARVI-410255725001_2.jpg",563 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/ALSV0ovgBsx-410255725001_3.jpg",564 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/vGybxj3vi3f-410255725001_4.jpg",565 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/KM1KPWS7gIk-410255725001_5.jpg",566 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/NmHExkPARVI-410255725001_2.jpg",567 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/ALSV0ovgBsx-410255725001_3.jpg",568 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/vGybxj3vi3f-410255725001_4.jpg",569 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/KM1KPWS7gIk-410255725001_5.jpg"570 ]571 },572 "brand": {573 "credit_note_allowed": false,574 "brand_name": "Hunkemoller",575 "id": 356,576 "modified_on": "2023-06-20T18:49:25+00:00",577 "is_virtual_invoice": false,578 "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/media/logo/brand/original/1129_43ac065d3d9f43c6b5adddcb33294e77.jpg",579 "created_on": "2017-02-08T13:40:44+00:00"580 },581 "bag_id": 33844743,582 "article": {583 "identifiers": {584 "alu": "000000410255725001"585 },586 "esp_modified": false,587 "size": "XS",588 "code": "",589 "raw_meta": null,590 "set": {},591 "is_set": false,592 "seller_identifier": "000000410255725001",593 "return_config": {594 "time": 0,595 "unit": "days",596 "returnable": false597 },598 "_id": "62842a1b68812ee2b6d0b9d9",599 "uid": "62842a1b68812ee2b6d0b9d9",600 "child_details": {},601 "dimensions": {602 "unit": "cm",603 "width": 17,604 "height": 8,605 "length": 27.5,606 "is_default": true607 },608 "weight": {609 "unit": "gram",610 "shipping": 100,611 "is_default": true612 },613 "currency": {614 "code": "INR",615 "rate": 1616 },617 "expiration_date": "9998-01-30 23:59:00"618 },619 "current_operational_status": {620 "id": 216808131,621 "updated_ts": "2024-03-31T05:45:02Z",622 "kafka_sync": false,623 "shipment_id": "17118062289491816415",624 "state_type": "operational",625 "state_id": 113,626 "updated_at": "2024-03-31T11:15:02+00:00",627 "bag_id": 33844743,628 "created_at": "2024-03-31T11:15:02+00:00",629 "delivery_awb_number": null,630 "delivery_partner_id": null,631 "created_ts": "2024-03-31T05:45:02Z",632 "store_id": 14406,633 "status": "ready_for_dp_assignment",634 "bag_state_mapper": {635 "journey_type": "forward",636 "app_display_name": "Ready For Dp Assignment",637 "state_type": "operational",638 "app_state_name": "ready_for_dp_assignment",639 "name": "ready_for_dp_assignment",640 "app_facing": false,641 "id": 113,642 "display_name": "Ready For Dp Assignment",643 "notify_customer": false,644 "is_active": true645 },646 "reasons": [],647 "action_user": {}648 },649 "affiliate_bag_details": {650 "affiliate_bag_id": "33844743",651 "affiliate_order_id": "251640",652 "affiliate_meta": {653 "fynd": {654 "fulfilment_identifier": "pulse",655 "fulfilment_identifiers_list": [656 "pulse"657 ]658 },659 "channel_shipment_id": null,660 "channel_order_id": null,661 "due_date": null,662 "is_priority": false,663 "box_type": null,664 "coupon_code": "",665 "size_level_total_qty": 1,666 "loyalty_discount": 0,667 "employee_discount": 0668 },669 "loyalty_discount": 0,670 "employee_discount": 0671 },672 "payment_methods": {673 "PP": {674 "amount": 697675 }676 },677 "quantity": 1,678 "prices": {679 "price_effective": 697,680 "discount": 698,681 "amount_paid": 697,682 "coupon_effective_discount": 0,683 "delivery_charge": 0,684 "fynd_credits": 0,685 "cod_charges": 0,686 "refund_credit": 0,687 "cashback": 0,688 "refund_amount": 697,689 "added_to_fynd_cash": false,690 "cashback_applied": 0,691 "gst_tax_percentage": 5,692 "value_of_good": 663.81,693 "price_marked": 1395,694 "transfer_price": 0,695 "brand_calculated_amount": 697,696 "tax_collected_at_source": 0,697 "tcs_percentage": 0,698 "promotion_effective_discount": 0,699 "gift_price": 0,700 "coupon_value": 0,701 "seller_promotion_effective_discount": 0,702 "fynd_promotion_effective_discount": 0,703 "amount_paid_roundoff": 697704 },705 "order_created": "2024-03-30T19:13:49+00:00",706 "gst_details": {707 "gstin_code": "06AADCR7395F1Z4",708 "gst_tag": "IGST",709 "hsn_code": "61124100",710 "value_of_good": 663.81,711 "gst_tax_percentage": 5,712 "is_default_hsn_code": false,713 "brand_calculated_amount": 697,714 "tax_collected_at_source": 0,715 "hsn_code_id": "627783865e4c6fdbc8be3f98",716 "gst_fee": 33.19,717 "igst_tax_percentage": 5,718 "sgst_tax_percentage": 0,719 "cgst_tax_percentage": 0,720 "igst_gst_fee": 33.19,721 "cgst_gst_fee": "0",722 "sgst_gst_fee": "0",723 "tax_rule_id": "627783925e4c6fdbc8be40c7"724 },725 "line_number": 2,726 "applied_promos": [],727 "taxes": [728 {729 "name": "GST",730 "rate": 0.09,731 "taxable_amount": 231.19,732 "tax_amount": 20.81733 }734 ],735 "meta": {736 "group_id": "",737 "gift_card": {738 "gift_price": 0,739 "display_text": "",740 "is_gift_applied": false741 },742 "extra_meta": {743 "price_marked": "1395.00",744 "price_effective": 697745 },746 "_custom_json": {747 "_display": []748 },749 "docket_number": "171180622894918164152",750 "partial_can_ret": false,751 "country_of_origin": "China",752 "parent_docket_number": "171180622894918164152",753 "product_discount_applied": {754 "_id": "65f2c7c5352864fccbd0b7dc",755 "job_id": "65f2c7aba17754320ad4f33c",756 "app_ids": [757 "614b42d1ea943427b5f46d1e"758 ],759 "item_id": 1182446,760 "discount": [761 {762 "value": 50,763 "min_items": 1764 }765 ],766 "zone_ids": [],767 "abandoned": false,768 "brand_ids": [769 356770 ],771 "company_id": 46,772 "created_on": "2024-03-14T13:49:02.699000",773 "modified_on": "2024-03-14T13:49:02.699000",774 "discount_job": {775 "_id": "65f2c7aba17754320ad4f33c",776 "meta": {777 "triggerhappyEndJob": "65f3003562b57f4a495ca54f",778 "triggerhappyStartJob": "65f3003562b57f779c5ca54e"779 },780 "name": "HKM BRA PARTY FLAT 50% OFF",781 "value": null,782 "app_ids": [783 "614b42d1ea943427b5f46d1e"784 ],785 "job_type": "app|brand|inventory",786 "validity": {787 "end": "2024-04-29T18:30:00",788 "start": "2024-03-14T18:50:00"789 },790 "zone_ids": [],791 "brand_ids": [792 356793 ],794 "file_path": "/company/46/self/documents/product-import/free/original/KlA4KBqfk-50percent-off.xlsx",795 "is_active": true,796 "company_id": 46,797 "created_by": {798 "user_id": "23542762",799 "username": "test_example_com_12345"800 },801 "created_on": "2024-03-14T09:47:23.981000",802 "modified_by": {803 "user_id": "23542762",804 "username": "test_example_com_12345"805 },806 "modified_on": "2024-03-14T18:50:00.061000",807 "discount_meta": {808 "hours": 0,809 "timer": false,810 "minutes": 0811 },812 "discount_type": "percentage",813 "discount_level": "application"814 },815 "discount_meta": {816 "end": "2024-04-29T18:30:00Z",817 "start": "2024-03-14T18:50:00Z",818 "timer": false819 },820 "discount_type": "percentage",821 "seller_identifier": "000000410255725001"822 },823 "delivery_charges_hsn_code": "996819",824 "multi_quantity_bag_enabled": false825 }826 }827 ],828 "bag_status_history": [829 {830 "id": 216743852,831 "updated_ts": "2024-03-30T13:43:49Z",832 "kafka_sync": false,833 "shipment_id": "17118062289491816415",834 "state_type": "operational",835 "state_id": 89,836 "updated_at": "2024-03-30T19:13:49+00:00",837 "bag_id": 33844742,838 "created_at": "2024-03-30T19:13:49+00:00",839 "delivery_awb_number": null,840 "delivery_partner_id": null,841 "created_ts": "2024-03-30T13:43:49Z",842 "store_id": 14406,843 "status": "pending",844 "bag_state_mapper": {845 "journey_type": "forward",846 "app_display_name": "Pending",847 "state_type": "operational",848 "app_state_name": "pending",849 "name": "pending",850 "app_facing": true,851 "id": 89,852 "display_name": "Pending",853 "notify_customer": true,854 "is_active": true855 },856 "reasons": [],857 "action_user": {}858 },859 {860 "id": 216743931,861 "updated_ts": "2024-03-30T13:44:50Z",862 "kafka_sync": false,863 "shipment_id": "17118062289491816415",864 "state_type": "operational",865 "state_id": 1,866 "updated_at": "2024-03-30T19:14:51+00:00",867 "bag_id": 33844742,868 "created_at": "2024-03-30T19:14:51+00:00",869 "delivery_awb_number": null,870 "delivery_partner_id": null,871 "created_ts": "2024-03-30T13:44:50Z",872 "store_id": 14406,873 "status": "placed",874 "bag_state_mapper": {875 "journey_type": "forward",876 "app_display_name": "Processing",877 "state_type": "operational",878 "app_state_name": "processing",879 "name": "placed",880 "app_facing": true,881 "id": 1,882 "display_name": "Placed",883 "notify_customer": true,884 "is_active": true885 },886 "reasons": [],887 "action_user": {}888 },889 {890 "id": 216808119,891 "updated_ts": "2024-03-31T05:45:01Z",892 "kafka_sync": false,893 "shipment_id": "17118062289491816415",894 "state_type": "operational",895 "state_id": 2,896 "updated_at": "2024-03-31T11:15:02+00:00",897 "bag_id": 33844742,898 "created_at": "2024-03-31T11:15:02+00:00",899 "delivery_awb_number": null,900 "delivery_partner_id": null,901 "created_ts": "2024-03-31T05:45:01Z",902 "store_id": 14406,903 "status": "bag_confirmed",904 "bag_state_mapper": {905 "journey_type": "forward",906 "app_display_name": "Confirmed",907 "state_type": "operational",908 "app_state_name": "confirmed",909 "name": "bag_confirmed",910 "app_facing": true,911 "id": 2,912 "display_name": "Confirmed",913 "notify_customer": false,914 "is_active": true915 },916 "reasons": [],917 "action_user": {918 "title": "Staff",919 "user_id": "23546659",920 "user_name": "65967faf620ff7c9db513d9c",921 "order_role": "full_access",922 "employee_code": ""923 }924 },925 {926 "id": 216808124,927 "updated_ts": "2024-03-31T05:45:02Z",928 "kafka_sync": false,929 "shipment_id": "17118062289491816415",930 "state_type": "operational",931 "state_id": 91,932 "updated_at": "2024-03-31T11:15:02+00:00",933 "bag_id": 33844742,934 "created_at": "2024-03-31T11:15:02+00:00",935 "delivery_awb_number": null,936 "delivery_partner_id": null,937 "created_ts": "2024-03-31T05:45:02Z",938 "store_id": 14406,939 "status": "bag_invoiced",940 "bag_state_mapper": {941 "journey_type": "forward",942 "app_display_name": "Bag Invoiced",943 "state_type": "operational",944 "app_state_name": "bag_invoiced",945 "name": "bag_invoiced",946 "app_facing": false,947 "id": 91,948 "display_name": "Bag Invoiced",949 "notify_customer": false,950 "is_active": true951 },952 "reasons": [],953 "action_user": {}954 },955 {956 "id": 216808130,957 "updated_ts": "2024-03-31T05:45:02Z",958 "kafka_sync": false,959 "shipment_id": "17118062289491816415",960 "state_type": "operational",961 "state_id": 113,962 "updated_at": "2024-03-31T11:15:02+00:00",963 "bag_id": 33844742,964 "created_at": "2024-03-31T11:15:02+00:00",965 "delivery_awb_number": null,966 "delivery_partner_id": null,967 "created_ts": "2024-03-31T05:45:02Z",968 "store_id": 14406,969 "status": "ready_for_dp_assignment",970 "bag_state_mapper": {971 "journey_type": "forward",972 "app_display_name": "Ready For Dp Assignment",973 "state_type": "operational",974 "app_state_name": "ready_for_dp_assignment",975 "name": "ready_for_dp_assignment",976 "app_facing": false,977 "id": 113,978 "display_name": "Ready For Dp Assignment",979 "notify_customer": false,980 "is_active": true981 },982 "reasons": [],983 "action_user": {}984 }985 ],986 "fulfilling_store": {987 "id": 14406,988 "code": "R578",989 "name": "Luhari DC",990 "address": "test address",991 "state": "Haryana",992 "city": "Jhajjar",993 "pincode": "124108",994 "country": "India",995 "phone": "1111111111",996 "meta": {997 "timing": [998 {999 "weekday": "monday",1000 "opening": {1001 "hour": 11,1002 "minute": 01003 },1004 "closing": {1005 "hour": 22,1006 "minute": 01007 },1008 "open": true1009 },1010 {1011 "weekday": "tuesday",1012 "opening": {1013 "hour": 11,1014 "minute": 01015 },1016 "closing": {1017 "hour": 22,1018 "minute": 01019 },1020 "open": true1021 },1022 {1023 "weekday": "wednesday",1024 "opening": {1025 "hour": 11,1026 "minute": 01027 },1028 "closing": {1029 "hour": 22,1030 "minute": 01031 },1032 "open": true1033 },1034 {1035 "weekday": "thursday",1036 "opening": {1037 "hour": 11,1038 "minute": 01039 },1040 "closing": {1041 "hour": 22,1042 "minute": 01043 },1044 "open": true1045 },1046 {1047 "weekday": "friday",1048 "opening": {1049 "hour": 11,1050 "minute": 01051 },1052 "closing": {1053 "hour": 22,1054 "minute": 01055 },1056 "open": true1057 },1058 {1059 "weekday": "saturday",1060 "opening": {1061 "hour": 11,1062 "minute": 01063 },1064 "closing": {1065 "hour": 22,1066 "minute": 01067 },1068 "open": true1069 },1070 {1071 "weekday": "sunday",1072 "opening": {1073 "hour": 11,1074 "minute": 01075 },1076 "closing": {1077 "hour": 22,1078 "minute": 01079 },1080 "open": true1081 }1082 ],1083 "stage": null,1084 "display_name": "Luhari DC",1085 "notification_emails": [1086 "test@example.com",1087 "test@example.com"1088 ],1089 "product_return_config": {1090 "on_same_store": true1091 },1092 "gst_credentials": {1093 "e_invoice": {1094 "enabled": false1095 },1096 "e_waybill": {1097 "enabled": false1098 }1099 },1100 "gst_number": "06AADCR7395F1Z4",1101 "additional_contact_details": {1102 "number": [1103 "91 - 8888888888",1104 "91 - 8888888888"1105 ]1106 },1107 "documents": {1108 "gst": {1109 "type": "gst",1110 "value": "06AADCR7395F1Z4",1111 "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/46/stores/all/legal/documents/free/original/o9DgOj4Qu-GST-WH.pdf",1112 "verified": true,1113 "legal_name": "Reliance Brands Limited"1114 }1115 },1116 "auto_invoice": true,1117 "credit_note": true,1118 "ewaybill_portal_details": null1119 },1120 "fulfillment_channel": "pulse",1121 "location_type": "warehouse",1122 "company_id": 46,1123 "is_active": false,1124 "tags": []1125 },1126 "prices": {1127 "amount_paid": 2094,1128 "refund_amount": 2094,1129 "price_marked": 4190,1130 "cod_charges": 0,1131 "discount": 2096,1132 "cashback_applied": 0,1133 "delivery_charge": 0,1134 "fynd_credits": 0,1135 "cashback": 0,1136 "price_effective": 2094,1137 "refund_credit": 0,1138 "value_of_good": 1911.13,1139 "coupon_value": 0,1140 "tax_collected_at_source": 0,1141 "promotion_effective_discount": 0,1142 "fynd_promotion_effective_discount": 0,1143 "seller_promotion_effective_discount": 0,1144 "cn_refund_amount": 0,1145 "gift_price": 0,1146 "amount_paid_roundoff": 20941147 },1148 "payments": {1149 "id": 8,1150 "mode": "PP",1151 "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png",1152 "display_name": "PartnerPay",1153 "display_priority": 7,1154 "source": "PartnerPay",1155 "is_active": false1156 },1157 "affiliate_details": {1158 "id": "614b42d1ea943427b5f46d1e",1159 "affiliate_bag_id": "33844742",1160 "affiliate_order_id": "251640",1161 "company_affiliate_tag": "HUNKEMOLLER_IN",1162 "affiliate_id": "614b42d1ea943427b5f46d1e",1163 "affiliate_shipment_id": "17118062289491816415",1164 "shipment_meta": {1165 "sla": 1711979028,1166 "weight": 200,1167 "external": {},1168 "vertical": "NA",1169 "dimension": {1170 "width": 34.29,1171 "height": 11,1172 "length": 43.181173 },1174 "formatted": {1175 "max": "Sun, 07 Apr",1176 "min": "Fri, 05 Apr"1177 },1178 "lock_data": {1179 "mto": false,1180 "locked": false,1181 "lock_message": ""1182 },1183 "timestamp": {1184 "max": 1712497428,1185 "min": 17123246281186 },1187 "bag_weight": {1188 "33844742": 100,1189 "33844743": 1001190 },1191 "debug_info": {1192 "stormbreaker_uuid": ""1193 },1194 "dp_options": {1195 "33": {1196 "name": "dp_account|33",1197 "type": "dp",1198 "dp_tat": {1199 "max": 345600,1200 "min": 1728001201 },1202 "sub_type": "dp_account",1203 "area_code": {1204 "to_pincode": "",1205 "from_pincode": ""1206 },1207 "is_active": true,1208 "parent_id": "dp:33",1209 "scheme_id": "65952d8eb8ac58febb890c04",1210 "f_priority": 1,1211 "operations": [],1212 "qc_enabled": false,1213 "r_priority": 1,1214 "fm_priority": 1,1215 "lm_priority": 1,1216 "display_name": "Bluedart Express 0-5kg",1217 "extension_id": "656f216f9117f06286a7c6f7",1218 "payment_mode": "all",1219 "rvp_priority": 1,1220 "assign_dp_from_sb": false,1221 "dp_shipping_charges": 200,1222 "external_account_id": "65952d8eb8ac58febb890c04",1223 "internal_account_id": 331224 }1225 },1226 "order_type": null,1227 "dp_sort_key": null,1228 "is_self_ship": false,1229 "shipment_cost": 2094,1230 "delivery_slots": {},1231 "is_auto_assign": true,1232 "packaging_name": "POLYB_L_1713P5",1233 "courier_partners": [1234 {1235 "tat": {1236 "max": 345600,1237 "min": 1728001238 },1239 "slug": "656f216f9117f06286a7c6f7|65952d8eb8ac58febb890c04",1240 "area_code": {1241 "source": null,1242 "destination": null1243 },1244 "scheme_id": "65952d8eb8ac58febb890c04",1245 "display_name": "Bluedart Express 0-5kg",1246 "extension_id": "656f216f9117f06286a7c6f7",1247 "is_self_ship": false,1248 "is_qc_enabled": false,1249 "is_own_account": false1250 },1251 {1252 "tat": {1253 "max": 345600,1254 "min": 1728001255 },1256 "slug": "656f1f18c24dabc79325b1ba|65952a7b199ac0fd9537b1a7",1257 "area_code": {1258 "source": null,1259 "destination": null1260 },1261 "scheme_id": "65952a7b199ac0fd9537b1a7",1262 "display_name": "Delhivery Air 0-1kg",1263 "extension_id": "656f1f18c24dabc79325b1ba",1264 "is_self_ship": false,1265 "is_qc_enabled": false,1266 "is_own_account": false1267 },1268 {1269 "tat": {1270 "max": 345600,1271 "min": 1728001272 },1273 "slug": "656f20c89117f06286a7c6f2|65952bd1974836aaa9869518",1274 "area_code": {1275 "source": null,1276 "destination": null1277 },1278 "scheme_id": "65952bd1974836aaa9869518",1279 "display_name": "Xpressbees Air 0-1kg",1280 "extension_id": "656f20c89117f06286a7c6f2",1281 "is_self_ship": false,1282 "is_qc_enabled": false,1283 "is_own_account": false1284 },1285 {1286 "tat": {1287 "max": 345600,1288 "min": 1728001289 },1290 "slug": "656f20b99117f06286a7c6ed|6595265414c31ce4b279d9c6",1291 "area_code": {1292 "source": null,1293 "destination": null1294 },1295 "scheme_id": "6595265414c31ce4b279d9c6",1296 "display_name": "Ecomexpress Surface 0-5kg",1297 "extension_id": "656f20b99117f06286a7c6ed",1298 "is_self_ship": false,1299 "is_qc_enabled": false,1300 "is_own_account": false1301 }1302 ],1303 "fulfillment_tags": [],1304 "is_international": false,1305 "is_export_shipment": false,1306 "same_store_available": true,1307 "fulfill_virtual_invoice": true,1308 "fulfilment_priority_text": null,1309 "store_invoice_updated_ts": "2024-03-31T05:45:02Z",1310 "store_invoice_updated_date": "2024-03-31T11:15:02+00:00",1311 "E-invoice_applicable_response": {1312 "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",1313 "is_applicable": false1314 },1315 "auto_trigger_dp_assignment_ACF": true,1316 "eligible_for_split": false1317 },1318 "affiliate_meta": {1319 "fynd": {1320 "fulfilment_identifier": "pulse",1321 "fulfilment_identifiers_list": [1322 "pulse"1323 ]1324 },1325 "channel_shipment_id": null,1326 "channel_order_id": null,1327 "due_date": null,1328 "is_priority": false,1329 "box_type": null,1330 "coupon_code": "",1331 "size_level_total_qty": 1,1332 "loyalty_discount": 0,1333 "employee_discount": 01334 },1335 "affiliate_store_id": "14406",1336 "pdf_links": {1337 "label_type": "fynd",1338 "invoice_type": "fynd"1339 },1340 "config": {1341 "id": "614b42d1ea943427b5f46d1e",1342 "meta": [],1343 "name": "HUNKEMOLLER_IN",1344 "owner": "5dcfacd2cde9054e3d667660",1345 "token": "iDPuTkCNL",1346 "secret": "SC7_8fh52H",1347 "createdAt": null,1348 "updatedAt": null,1349 "description": "",1350 "dp_assignment": true,1351 "app_company_id": 46,1352 "article_assignment": {1353 "level": "multi-companies",1354 "strategy": "optimal"1355 },1356 "force_reassignment": false,1357 "sales_channel_logo": "/company/46/applications/614b42d1ea943427b5f46d1e/application/pictures/free-logo/original/LpwOk-7Lf-HUNKEMOLLER_IN.png",1358 "order_source_domain": "hunkemoller.fynd.io",1359 "post_order_reassignment": true1360 }1361 },1362 "article_details": {1363 "status": {1364 "ready_for_dp_assignment": {1365 "630de4e5ea54210bdddf2882": {1366 "uid": "630de4e5ea54210bdddf2882",1367 "_id": "630de4e5ea54210bdddf2882",1368 "is_set": false,1369 "bag_ids": [1370 {1371 "bag_id": 33844742,1372 "quantity": 11373 }1374 ],1375 "quantity": 1,1376 "reasons": {}1377 },1378 "62842a1b68812ee2b6d0b9d9": {1379 "uid": "62842a1b68812ee2b6d0b9d9",1380 "_id": "62842a1b68812ee2b6d0b9d9",1381 "is_set": false,1382 "bag_ids": [1383 {1384 "bag_id": 33844743,1385 "quantity": 11386 }1387 ],1388 "quantity": 1,1389 "reasons": {}1390 }1391 }1392 }1393 },1394 "dp_details": {1395 "id": null,1396 "name": null,1397 "awb_no": null,1398 "eway_bill_id": null,1399 "track_url": null,1400 "gst_tag": "sgst",1401 "extension_id": null,1402 "scheme_id": null,1403 "courier_partner_slug": null1404 },1405 "rto_address": {1406 "store_address_json": {1407 "version": "1.0",1408 "contact_person": "test",1409 "address": "",1410 "address1": "test address",1411 "address2": "dummy data",1412 "name": "test",1413 "area": "",1414 "area_code": "",1415 "area_code_slug": "",1416 "landmark": "test address",1417 "city": "Jhajjar",1418 "state": "Haryana",1419 "country": "India",1420 "pincode": "124108",1421 "longitude": 72.8423802,1422 "sector": "",1423 "latitude": 19.0653252,1424 "phone": "1111111111",1425 "email": "test@example.com",1426 "address_type": "store",1427 "address_category": "store",1428 "created_at": "2024-03-31 11:15:02",1429 "updated_at": "2024-03-31 11:15:02",1430 "country_phone_code": null,1431 "country_iso_code": "IN",1432 "country_code": "IN",1433 "display_address": "test address"1434 },1435 "code": "R578",1436 "id": 14406,1437 "location_type": "warehouse",1438 "name": "Luhari DC",1439 "company_id": 46,1440 "address1": "test address",1441 "address2": "test address",1442 "display_address": "test address",1443 "city": "Jhajjar",1444 "state": "Haryana",1445 "sector": "",1446 "country": "India",1447 "pincode": "124108",1448 "store_email": "test@example.com",1449 "contact_person": "test",1450 "phone": "1111111111"1451 },1452 "weight": {1453 "value": 200,1454 "unit": "gram"1455 },1456 "shipment_meta": {1457 "sla": 1711979028,1458 "weight": 200,1459 "external": {},1460 "vertical": "NA",1461 "dimension": {1462 "width": 34.29,1463 "height": 11,1464 "length": 43.181465 },1466 "formatted": {1467 "max": "Sun, 07 Apr",1468 "min": "Fri, 05 Apr"1469 },1470 "lock_data": {1471 "mto": false,1472 "locked": false,1473 "lock_message": ""1474 },1475 "timestamp": {1476 "max": 1712497428,1477 "min": 17123246281478 },1479 "bag_weight": {1480 "33844742": 100,1481 "33844743": 1001482 },1483 "debug_info": {1484 "stormbreaker_uuid": ""1485 },1486 "dp_options": {1487 "33": {1488 "name": "dp_account|33",1489 "type": "dp",1490 "dp_tat": {1491 "max": 345600,1492 "min": 1728001493 },1494 "sub_type": "dp_account",1495 "area_code": {1496 "to_pincode": "",1497 "from_pincode": ""1498 },1499 "is_active": true,1500 "parent_id": "dp:33",1501 "scheme_id": "65952d8eb8ac58febb890c04",1502 "f_priority": 1,1503 "operations": [],1504 "qc_enabled": false,1505 "r_priority": 1,1506 "fm_priority": 1,1507 "lm_priority": 1,1508 "display_name": "Bluedart Express 0-5kg",1509 "extension_id": "656f216f9117f06286a7c6f7",1510 "payment_mode": "all",1511 "rvp_priority": 1,1512 "assign_dp_from_sb": false,1513 "dp_shipping_charges": 200,1514 "external_account_id": "65952d8eb8ac58febb890c04",1515 "internal_account_id": 331516 }1517 },1518 "order_type": null,1519 "dp_sort_key": null,1520 "is_self_ship": false,1521 "shipment_cost": 2094,1522 "delivery_slots": {},1523 "is_auto_assign": true,1524 "packaging_name": "POLYB_L_1713P5",1525 "courier_partners": [1526 {1527 "tat": {1528 "max": 345600,1529 "min": 1728001530 },1531 "slug": "656f216f9117f06286a7c6f7|65952d8eb8ac58febb890c04",1532 "area_code": {1533 "source": null,1534 "destination": null1535 },1536 "scheme_id": "65952d8eb8ac58febb890c04",1537 "display_name": "Bluedart Express 0-5kg",1538 "extension_id": "656f216f9117f06286a7c6f7",1539 "is_self_ship": false,1540 "is_qc_enabled": false,1541 "is_own_account": false1542 },1543 {1544 "tat": {1545 "max": 345600,1546 "min": 1728001547 },1548 "slug": "656f1f18c24dabc79325b1ba|65952a7b199ac0fd9537b1a7",1549 "area_code": {1550 "source": null,1551 "destination": null1552 },1553 "scheme_id": "65952a7b199ac0fd9537b1a7",1554 "display_name": "Delhivery Air 0-1kg",1555 "extension_id": "656f1f18c24dabc79325b1ba",1556 "is_self_ship": false,1557 "is_qc_enabled": false,1558 "is_own_account": false1559 },1560 {1561 "tat": {1562 "max": 345600,1563 "min": 1728001564 },1565 "slug": "656f20c89117f06286a7c6f2|65952bd1974836aaa9869518",1566 "area_code": {1567 "source": null,1568 "destination": null1569 },1570 "scheme_id": "65952bd1974836aaa9869518",1571 "display_name": "Xpressbees Air 0-1kg",1572 "extension_id": "656f20c89117f06286a7c6f2",1573 "is_self_ship": false,1574 "is_qc_enabled": false,1575 "is_own_account": false1576 },1577 {1578 "tat": {1579 "max": 345600,1580 "min": 1728001581 },1582 "slug": "656f20b99117f06286a7c6ed|6595265414c31ce4b279d9c6",1583 "area_code": {1584 "source": null,1585 "destination": null1586 },1587 "scheme_id": "6595265414c31ce4b279d9c6",1588 "display_name": "Ecomexpress Surface 0-5kg",1589 "extension_id": "656f20b99117f06286a7c6ed",1590 "is_self_ship": false,1591 "is_qc_enabled": false,1592 "is_own_account": false1593 }1594 ],1595 "fulfillment_tags": [],1596 "is_international": false,1597 "is_export_shipment": false,1598 "same_store_available": true,1599 "fulfill_virtual_invoice": true,1600 "fulfilment_priority_text": null,1601 "store_invoice_updated_ts": "2024-03-31T05:45:02Z",1602 "store_invoice_updated_date": "2024-03-31T11:15:02+00:00",1603 "E-invoice_applicable_response": {1604 "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",1605 "is_applicable": false1606 },1607 "auto_trigger_dp_assignment_ACF": true,1608 "eligible_for_split": false1609 },1610 "shipment_gst": {1611 "value_of_good": 1911.13,1612 "gst_fee": 182.87,1613 "brand_calculated_amount": 2094,1614 "tax_collected_at_source": 0,1615 "gstin_code": "06AADCR7395F1Z4"1616 },1617 "store_invoice_id": "E00014406A009663",1618 "credit_note_id": "",1619 "order_created": "2024-03-30T19:13:49+00:00",1620 "payment_methods": {1621 "PP": {1622 "amount": 2094,1623 "mode": "PP",1624 "name": "PartnerPay",1625 "collect_by": "fynd",1626 "refund_by": "fynd",1627 "meta": {1628 "id": "FY660817140E6E656DB9",1629 "mode": "",1630 "logo_url": {1631 "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png",1632 "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png"1633 },1634 "payment_id": null1635 }1636 }1637 },1638 "payment_info": [],1639 "order": {1640 "ordering_channel": "ECOMM",1641 "ordering_source": "storefront",1642 "affiliate_order_date": "2024-03-30T19:13:49+00:00",1643 "affiliate_order_id": "251640",1644 "fynd_order_id": "FY660817140E6E656DB9",1645 "mode_of_payment": "ECOMM",1646 "source": "affiliate",1647 "total_order_value": 2094,1648 "collect_by": "fynd",1649 "refund_by": "fynd",1650 "order_value": 2094,1651 "meta": {1652 "mode": "live",1653 "files": [],1654 "staff": {},1655 "cart_id": -2,1656 "comment": "",1657 "currency": {1658 "currency_code": "INR",1659 "currency_name": "Indian Rupee",1660 "currency_symbol": "₹",1661 "currency_sub_unit": "Paisa"1662 },1663 "device_id": null,1664 "extra_meta": {},1665 "order_tags": [],1666 "order_type": "HomeDelivery",1667 "custom_cart": {},1668 "custom_meta": [],1669 "employee_id": null,1670 "company_logo": "/company/46/applications/614b42d1ea943427b5f46d1e/application/pictures/free-logo/original/LpwOk-7Lf-HUNKEMOLLER_IN.png",1671 "payment_type": "fynd",1672 "mongo_cart_id": -2,1673 "cart_object_id": "None",1674 "order_platform": "openapi",1675 "ordering_store": null,1676 "seller_details": {1677 "currency": {1678 "code": "INR",1679 "name": "Indian Rupee",1680 "symbol": "Rs."1681 },1682 "timezone": "Asia/Kolkata",1683 "country_code": "IN"1684 },1685 "conversion_rate": {1686 "base": "INR",1687 "rates": {1688 "INR": {1689 "name": "Indian Rupee",1690 "value": 1,1691 "symbol": "₹",1692 "sub_unit": "Paisa"1693 }1694 },1695 "timestamp": 17117568140001696 },1697 "currency_symbol": "₹",1698 "transaction_data": {1699 "id": "FY660817140E6E656DB9",1700 "app_id": "614b42d1ea943427b5f46d1e",1701 "device": "desktop",1702 "source": "desktop-fynd",1703 "status": "complete",1704 "headers": {1705 "via": "1.1 google",1706 "host": "api.fynd.com",1707 "accept": "*/*",1708 "x-scheme": "https",1709 "x-fp-date": "20240330T191450Z",1710 "x-real-ip": "34.100.227.214",1711 "user-agent": "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.13 (KHTML, like Gecko) Chrome/0.A.B.C Safari/525.13",1712 "x-skip-cors": "true",1713 "x-user-data": "{\"debug\":{\"source\":\"grimlock\",\"platform\":\"000000000000000000000001\"},\"username\":\"pritam_a7x_gmail_com_50522_23071964\",\"updated_at\":\"2024-02-12T03:24:17.694Z\",\"firstName\":\"test\",\"created_at\":\"2019-04-26T07:02:56.187Z\",\"lastName\":\"Ghosh\",\"_id\":\"5cd40115c01aac9daf2d048f\",\"phoneNumbers\":[{\"active\":true,\"country_code\":91,\"phone\":\"1111111111\",\"verified\":true,\"countryCode\":91,\"primary\":true}],\"updatedAt\":\"2024-02-12T03:24:17.694Z\",\"password_last_modified\":\"2024-02-12T03:24:17.688Z\",\"password_history\":[],\"profilePicUrl\":\"http:\\/\\/graph.facebook.com\\/123344\\/picture\\/?width=600&height=600\",\"phone_numbers\":[{\"active\":true,\"country_code\":91,\"phone\":\"1111111111\",\"verified\":true,\"countryCode\":91,\"primary\":true}],\"emails\":[{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":true},{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":false},{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":false}],\"last_name\":\"test\",\"first_name\":\"test\",\"gender\":\"male\",\"accountType\":\"user\",\"account_type\":\"user\",\"active\":true,\"profile_pic_url\":\"http:\\/\\/graph.facebook.com\\/111111\\/picture\\/?width=600&height=600\",\"createdAt\":\"2019-04-26T07:02:56.187Z\",\"status\":\"active\",\"__v\":5,\"uid\":\"23071964\"}",1714 "content-type": "application/json",1715 "x-request-id": "340fcb8e8ed34eba58f71b80892afafa",1716 "authorization": "Bearer oa-1231231231313",1717 "uber-trace-id": "43355fab23fedd7f:135397327c24f397:43355fab23fedd7f:1",1718 "x-super-admin": "true",1719 "content-length": "236",1720 "x-fp-signature": "v1.1:123124124",1721 "accept-encoding": "deflate, gzip, br",1722 "x-forwarded-for": "34.100.227.214",1723 "x-fynd-trace-id": "340fcb8e8ed34eba58f71b80892afafa",1724 "x-forwarded-host": "api.fynd.com",1725 "x-forwarded-port": "80",1726 "x-seller-details": "{\"country_code\":\"IN\",\"currency\":{\"code\":\"INR\",\"symbol\":\"Rs.\",\"name\":\"Indian Rupee\"},\"timezone\":\"Asia/Kolkata\"}",1727 "x-forwarded-proto": "https",1728 "x-forwarded-scheme": "https",1729 "x-cloud-trace-context": "a907e8735c74b4db6ca0ef15305a1f0e/12294800319076248065",1730 "x-original-forwarded-for": "34.100.227.214,34.120.64.114",1731 "x-super-admin-permission": "{\"access\":{\"all\":false,\"company\":[42,46,37,1244,870,25,2250,1486,52,1567,341,442,869,334,34,2411,718,1137,517,2467,1098,2853,568,1913,2374,2,6,21,320,1607,3089,269,3576,2212,2256,43,3075,2913,4118,1951,884,1354,1582,1568,770,1069,2566,1733,2201,1291,644,1588,2274,1077,2109,822,1572,1301,3557,615,1076,2704,20,1584,3932,1943,791,2242,2195,3866,840,3751,326,1849,1079,1103,1622,1814,3138,77,1875,1841,2930,2831,49,36,520,2196,1653,1678,3006,2270,2286,2108,2922,2150,1130,3670,1121,2486,3582,1613,3767,3573,3817,105,3952,1972,2989,163,2175,3647,4003,1253,1651,61,1328,3333,1211,4211,3969,1329,4169,516,3587,4182,292,739,2326,3887,3691,1803,342,1526,3405,1305,1101,1420,3619,59,1927,726,1202,4770]},\"partner_access\":{\"all\":false,\"organization\":[]},\"_id\":\"643926b1933c6ba75040f81d\",\"user\":\"5cd40115c01aac9daf2d048f\",\"title\":\"Super Admin\",\"type\":\"user\",\"permissions\":[\"company\",\"order\"],\"roles\":[\"custom\"],\"createdAt\":\"2023-04-14T10:10:57.621Z\",\"updatedAt\":\"2023-06-23T12:38:44.534Z\",\"__v\":16,\"updated_at\":\"2024-02-15T08:43:28.321Z\"}"1732 },1733 "offline": true,1734 "profile": "fynd",1735 "currency": "INR",1736 "merchant": {1737 "id": 321,1738 "meta": {1739 "auto_refund": true1740 },1741 "delivery_config": {1742 "cod": {1743 "refund_by": "fynd",1744 "collect_by": "fynd"1745 }1746 }1747 },1748 "order_id": "FY660817140E6E656DB9",1749 "client_ip": "",1750 "company_id": "46",1751 "is_webview": false,1752 "app_version": null,1753 "merchant_id": 321,1754 "payment_meta": {1755 "order_id": "order_NsaTqdy0WRRHeZ",1756 "payment_id": "pay_NsaUP8baXTb9yx",1757 "current_status": "captured",1758 "payment_gateway": "Razorpay"1759 },1760 "origin_app_id": "614b42d1ea943427b5f46d1e",1761 "source_domain": null,1762 "is_app_request": false,1763 "is_ios_request": false,1764 "is_legacy_flow": false,1765 "aggregator_name": "Openapi",1766 "payment_methods": [1767 {1768 "meta": {1769 "order_id": "order_NsaTqdy0WRRHeZ",1770 "payment_id": "pay_NsaUP8baXTb9yx",1771 "current_status": "captured",1772 "payment_gateway": "Razorpay"1773 },1774 "mode": "PP",1775 "name": "prepaid",1776 "amount": 2094001777 }1778 ],1779 "x-currency-code": "",1780 "platform_request": "fynd",1781 "x-seller-details": {1782 "currency": {1783 "code": "INR",1784 "name": "Indian Rupee",1785 "symbol": "Rs."1786 },1787 "timezone": "Asia/Kolkata",1788 "country_code": "IN"1789 },1790 "is_anonymous_user": false,1791 "x-location-detail": {},1792 "is_android_request": false,1793 "merchant_profile_id": 964,1794 "merchant_aggregator_id": 24,1795 "merchant_payment_config": {1796 "offline": {1797 "cod": {1798 "pos": {1799 "name": "Cash on Delivery (COD)",1800 "is_active": true,1801 "cod_charges": 0,1802 "anonymous_cod": false,1803 "user_cod_limit": 0,1804 "cod_max_order_value": 49000,1805 "cod_min_order_value": 0,1806 "cod_charges_max_value": 49000,1807 "cod_charges_min_value": 01808 },1809 "storefront": {1810 "name": "Cash on Delivery (COD)",1811 "is_active": true,1812 "cod_charges": 0,1813 "anonymous_cod": false,1814 "user_cod_limit": 0,1815 "cod_max_order_value": 49000,1816 "cod_min_order_value": 0,1817 "cod_charges_max_value": 49000,1818 "cod_charges_min_value": 01819 }1820 },1821 "is_active": true1822 }1823 },1824 "merchant_profile_payment_config": {1825 "offline": {1826 "cod": {1827 "is_active": true1828 }1829 }1830 }1831 },1832 "sales_channel_logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/46/applications/614b42d1ea943427b5f46d1e/application/pictures/free-logo/original/LpwOk-7Lf-HUNKEMOLLER_IN.png",1833 "usable_credit_notes": [],1834 "order_child_entities": [1835 "bag",1836 "shipment"1837 ],1838 "billing_staff_details": {1839 "id": null,1840 "user": null,1841 "last_name": null,1842 "first_name": null,1843 "employee_code": null1844 },1845 "platform_user_details": {1846 "platform_user_id": null,1847 "platform_user_last_name": "",1848 "platform_user_first_name": "",1849 "platform_user_employee_code": null1850 }1851 }1852 },1853 "order_source": "affiliate",1854 "journey_type": "forward",1855 "einvoice_info": {},1856 "lock_status": false,1857 "original_bag_list": [1858 33844742,1859 338447431860 ],1861 "shipment_update_time": 1711863902.3125546,1862 "transaction_meta": {1863 "id": "FY660817140E6E656DB9",1864 "app_id": "614b42d1ea943427b5f46d1e",1865 "device": "desktop",1866 "source": "desktop-fynd",1867 "status": "complete",1868 "headers": {1869 "via": "1.1 google",1870 "host": "api.fynd.com",1871 "accept": "*/*",1872 "x-scheme": "https",1873 "x-fp-date": "20240330T191450Z",1874 "x-real-ip": "34.100.227.214",1875 "user-agent": "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.13 (KHTML, like Gecko) Chrome/0.A.B.C Safari/525.13",1876 "x-skip-cors": "true",1877 "x-user-data": "{\"debug\":{\"source\":\"grimlock\",\"platform\":\"000000000000000000000001\"},\"username\":\"pritam_a7x_gmail_com_50522_23071964\",\"updated_at\":\"2024-02-12T03:24:17.694Z\",\"firstName\":\"test\",\"created_at\":\"2019-04-26T07:02:56.187Z\",\"lastName\":\"test\",\"_id\":\"5cd40115c01aac9daf2d048f\",\"phoneNumbers\":[{\"active\":true,\"country_code\":91,\"phone\":\"1111111111\",\"verified\":true,\"countryCode\":91,\"primary\":true}],\"updatedAt\":\"2024-02-12T03:24:17.694Z\",\"password_last_modified\":\"2024-02-12T03:24:17.688Z\",\"password_history\":[],\"profilePicUrl\":\"http:\\/\\/graph.facebook.com\\/123123\\/picture\\/?width=600&height=600\",\"phone_numbers\":[{\"active\":true,\"country_code\":91,\"phone\":\"1111111111\",\"verified\":true,\"countryCode\":91,\"primary\":true}],\"emails\":[{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":true},{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":false},{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":false}],\"last_name\":\"test\",\"first_name\":\"test\",\"gender\":\"male\",\"accountType\":\"user\",\"account_type\":\"user\",\"active\":true,\"profile_pic_url\":\"http:\\/\\/graph.facebook.com\\/11111\\/picture\\/?width=600&height=600\",\"createdAt\":\"2019-04-26T07:02:56.187Z\",\"status\":\"active\",\"__v\":5,\"uid\":\"23071964\"}",1878 "content-type": "application/json",1879 "x-request-id": "340fcb8e8ed34eba58f71b80892afafa",1880 "authorization": "Bearer oa-1112133123",1881 "uber-trace-id": "43355fab23fedd7f:135397327c24f397:43355fab23fedd7f:1",1882 "x-super-admin": "true",1883 "content-length": "236",1884 "x-fp-signature": "v1.1:12312312313",1885 "accept-encoding": "deflate, gzip, br",1886 "x-forwarded-for": "34.100.227.214",1887 "x-fynd-trace-id": "340fcb8e8ed34eba58f71b80892afafa",1888 "x-forwarded-host": "api.fynd.com",1889 "x-forwarded-port": "80",1890 "x-seller-details": "{\"country_code\":\"IN\",\"currency\":{\"code\":\"INR\",\"symbol\":\"Rs.\",\"name\":\"Indian Rupee\"},\"timezone\":\"Asia/Kolkata\"}",1891 "x-forwarded-proto": "https",1892 "x-forwarded-scheme": "https",1893 "x-cloud-trace-context": "a907e8735c74b4db6ca0ef15305a1f0e/12294800319076248065",1894 "x-original-forwarded-for": "34.100.227.214,34.120.64.114",1895 "x-super-admin-permission": "{\"access\":{\"all\":false,\"company\":[42,46,37,1244,870,25,2250,1486,52,1567,341,442,869,334,34,2411,718,1137,517,2467,1098,2853,568,1913,2374,2,6,21,320,1607,3089,269,3576,2212,2256,43,3075,2913,4118,1951,884,1354,1582,1568,770,1069,2566,1733,2201,1291,644,1588,2274,1077,2109,822,1572,1301,3557,615,1076,2704,20,1584,3932,1943,791,2242,2195,3866,840,3751,326,1849,1079,1103,1622,1814,3138,77,1875,1841,2930,2831,49,36,520,2196,1653,1678,3006,2270,2286,2108,2922,2150,1130,3670,1121,2486,3582,1613,3767,3573,3817,105,3952,1972,2989,163,2175,3647,4003,1253,1651,61,1328,3333,1211,4211,3969,1329,4169,516,3587,4182,292,739,2326,3887,3691,1803,342,1526,3405,1305,1101,1420,3619,59,1927,726,1202,4770]},\"partner_access\":{\"all\":false,\"organization\":[]},\"_id\":\"643926b1933c6ba75040f81d\",\"user\":\"5cd40115c01aac9daf2d048f\",\"title\":\"Super Admin\",\"type\":\"user\",\"permissions\":[\"company\",\"order\"],\"roles\":[\"custom\"],\"createdAt\":\"2023-04-14T10:10:57.621Z\",\"updatedAt\":\"2023-06-23T12:38:44.534Z\",\"__v\":16,\"updated_at\":\"2024-02-15T08:43:28.321Z\"}"1896 },1897 "offline": true,1898 "profile": "fynd",1899 "currency": "INR",1900 "merchant": {1901 "id": 321,1902 "meta": {1903 "auto_refund": true1904 },1905 "delivery_config": {1906 "cod": {1907 "refund_by": "fynd",1908 "collect_by": "fynd"1909 }1910 }1911 },1912 "order_id": "FY660817140E6E656DB9",1913 "client_ip": "",1914 "company_id": "46",1915 "is_webview": false,1916 "app_version": null,1917 "merchant_id": 321,1918 "payment_meta": {1919 "order_id": "order_NsaTqdy0WRRHeZ",1920 "payment_id": "pay_NsaUP8baXTb9yx",1921 "current_status": "captured",1922 "payment_gateway": "Razorpay"1923 },1924 "origin_app_id": "614b42d1ea943427b5f46d1e",1925 "source_domain": null,1926 "is_app_request": false,1927 "is_ios_request": false,1928 "is_legacy_flow": false,1929 "aggregator_name": "Openapi",1930 "payment_methods": [1931 {1932 "meta": {1933 "order_id": "order_NsaTqdy0WRRHeZ",1934 "payment_id": "pay_NsaUP8baXTb9yx",1935 "current_status": "captured",1936 "payment_gateway": "Razorpay"1937 },1938 "mode": "PP",1939 "name": "prepaid",1940 "amount": 2094001941 }1942 ],1943 "x-currency-code": "",1944 "platform_request": "fynd",1945 "x-seller-details": {1946 "currency": {1947 "code": "INR",1948 "name": "Indian Rupee",1949 "symbol": "Rs."1950 },1951 "timezone": "Asia/Kolkata",1952 "country_code": "IN"1953 },1954 "is_anonymous_user": false,1955 "x-location-detail": {},1956 "is_android_request": false,1957 "merchant_profile_id": 964,1958 "merchant_aggregator_id": 24,1959 "merchant_payment_config": {1960 "offline": {1961 "cod": {1962 "pos": {1963 "name": "Cash on Delivery (COD)",1964 "is_active": true,1965 "cod_charges": 0,1966 "anonymous_cod": false,1967 "user_cod_limit": 0,1968 "cod_max_order_value": 49000,1969 "cod_min_order_value": 0,1970 "cod_charges_max_value": 49000,1971 "cod_charges_min_value": 01972 },1973 "storefront": {1974 "name": "Cash on Delivery (COD)",1975 "is_active": true,1976 "cod_charges": 0,1977 "anonymous_cod": false,1978 "user_cod_limit": 0,1979 "cod_max_order_value": 49000,1980 "cod_min_order_value": 0,1981 "cod_charges_max_value": 49000,1982 "cod_charges_min_value": 01983 }1984 },1985 "is_active": true1986 }1987 },1988 "merchant_profile_payment_config": {1989 "offline": {1990 "cod": {1991 "is_active": true1992 }1993 }1994 }1995 },1996 "meta": {1997 "sla": 1711979028,1998 "weight": 200,1999 "external": {},2000 "vertical": "NA",2001 "dimension": {2002 "width": 34.29,2003 "height": 11,2004 "length": 43.182005 },2006 "formatted": {2007 "max": "Sun, 07 Apr",2008 "min": "Fri, 05 Apr"2009 },2010 "lock_data": {2011 "mto": false,2012 "locked": false,2013 "lock_message": ""2014 },2015 "timestamp": {2016 "max": 1712497428,2017 "min": 17123246282018 },2019 "bag_weight": {2020 "33844742": 100,2021 "33844743": 1002022 },2023 "debug_info": {2024 "stormbreaker_uuid": ""2025 },2026 "dp_options": {2027 "33": {2028 "name": "dp_account|33",2029 "type": "dp",2030 "dp_tat": {2031 "max": 345600,2032 "min": 1728002033 },2034 "sub_type": "dp_account",2035 "area_code": {2036 "to_pincode": "",2037 "from_pincode": ""2038 },2039 "is_active": true,2040 "parent_id": "dp:33",2041 "scheme_id": "65952d8eb8ac58febb890c04",2042 "f_priority": 1,2043 "operations": [],2044 "qc_enabled": false,2045 "r_priority": 1,2046 "fm_priority": 1,2047 "lm_priority": 1,2048 "display_name": "Bluedart Express 0-5kg",2049 "extension_id": "656f216f9117f06286a7c6f7",2050 "payment_mode": "all",2051 "rvp_priority": 1,2052 "assign_dp_from_sb": false,2053 "dp_shipping_charges": 200,2054 "external_account_id": "65952d8eb8ac58febb890c04",2055 "internal_account_id": 332056 }2057 },2058 "order_type": null,2059 "dp_sort_key": null,2060 "is_self_ship": false,2061 "shipment_cost": 2094,2062 "delivery_slots": {},2063 "is_auto_assign": true,2064 "packaging_name": "POLYB_L_1713P5",2065 "courier_partners": [2066 {2067 "tat": {2068 "max": 345600,2069 "min": 1728002070 },2071 "slug": "656f216f9117f06286a7c6f7|65952d8eb8ac58febb890c04",2072 "area_code": {2073 "source": null,2074 "destination": null2075 },2076 "scheme_id": "65952d8eb8ac58febb890c04",2077 "display_name": "Bluedart Express 0-5kg",2078 "extension_id": "656f216f9117f06286a7c6f7",2079 "is_self_ship": false,2080 "is_qc_enabled": false,2081 "is_own_account": false2082 },2083 {2084 "tat": {2085 "max": 345600,2086 "min": 1728002087 },2088 "slug": "656f1f18c24dabc79325b1ba|65952a7b199ac0fd9537b1a7",2089 "area_code": {2090 "source": null,2091 "destination": null2092 },2093 "scheme_id": "65952a7b199ac0fd9537b1a7",2094 "display_name": "Delhivery Air 0-1kg",2095 "extension_id": "656f1f18c24dabc79325b1ba",2096 "is_self_ship": false,2097 "is_qc_enabled": false,2098 "is_own_account": false2099 },2100 {2101 "tat": {2102 "max": 345600,2103 "min": 1728002104 },2105 "slug": "656f20c89117f06286a7c6f2|65952bd1974836aaa9869518",2106 "area_code": {2107 "source": null,2108 "destination": null2109 },2110 "scheme_id": "65952bd1974836aaa9869518",2111 "display_name": "Xpressbees Air 0-1kg",2112 "extension_id": "656f20c89117f06286a7c6f2",2113 "is_self_ship": false,2114 "is_qc_enabled": false,2115 "is_own_account": false2116 },2117 {2118 "tat": {2119 "max": 345600,2120 "min": 1728002121 },2122 "slug": "656f20b99117f06286a7c6ed|6595265414c31ce4b279d9c6",2123 "area_code": {2124 "source": null,2125 "destination": null2126 },2127 "scheme_id": "6595265414c31ce4b279d9c6",2128 "display_name": "Ecomexpress Surface 0-5kg",2129 "extension_id": "656f20b99117f06286a7c6ed",2130 "is_self_ship": false,2131 "is_qc_enabled": false,2132 "is_own_account": false2133 }2134 ],2135 "fulfillment_tags": [],2136 "is_international": false,2137 "is_export_shipment": false,2138 "same_store_available": true,2139 "fulfill_virtual_invoice": true,2140 "fulfilment_priority_text": null,2141 "store_invoice_updated_ts": "2024-03-31T05:45:02Z",2142 "store_invoice_updated_date": "2024-03-31T11:15:02+00:00",2143 "E-invoice_applicable_response": {2144 "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",2145 "is_applicable": false2146 },2147 "auto_trigger_dp_assignment_ACF": true,2148 "eligible_for_split": false2149 },2150 "previous_shipment_id": null,2151 "fyndstore_emp": {},2152 "ordering_store": {},2153 "coupon": {},2154 "cart_info": {2155 "cart_id": "None",2156 "cart_uid": -22157 }2158 }2159 }2160}