Order
Manages orders, including processing, tracking, and updating order status.
Bag represents a virtual entity to group same items which contains single or multi quantity. Bags are part of a shipment. An order will have one or more than one shipments. A shipment can contain zero or more bags.
Operations
GET
# Retrieve Reasons for Cancellation and Return journey
Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations.
Parameters
shipment_idpath
string
Required
The unique identifier for the shipment
bag_idpath
string
Required
Identifier for a bag or product.
GET
Response
200
A successful response
Hide
reasons
array of object (BagReasons)
A list of reasons associated with the action, detailing the circumstances under which the rule is applied.
Show
qc_type
array of string
List of QC (Quality Control) types -- having return reason types indicating the stage at which QC is performed. - "Doorstep QC" refers involves inspecting products for damages at the customer's location before delivery. - "Pre QC" requires customers to upload product photos for a preliminary quality check by the operations team before a return or exchange pickup is arranged, ensuring criteria are met and optimizing logistics.
Enum
id
integer
A unique identifier for the bag reason.
display_name
string
The display name for the bag reason, used for user-facing purposes.
meta
object (BagReasonMeta)
Show
Additional metadata related to the reason, which may include specific conditions or configurations.
show_text_area
boolean
Indicates whether to display a text box on the front end.
remark_required
boolean
Indicates whether the text box added for remarks is optional or mandatory.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
question_set
array of object (QuestionSet)
An array of question sets linked to the bag reason, defining the questions to be answered.
Show
id
integer
The unique identifier for the question.
display_name
string
The text displayed for the question.
reasons
array of object (BagReasons)
An array of nested bag reasons that can further explain the primary reason.
Show
success
boolean
Indicates whether the API call was successful (true) or not (false).
rule_id
integer
Nullable
The unique identifier for the rule that is associated with the given reasons. This ID serves as a reference to the specific rule within the RMA system that governs or influences the reasons listed.
Examples
Parameters
shipment_id:
"17290285081731219531"
bag_id:
"2134"
Response
Retrieve Reasons for Cancellation and Return journey
getShipmentBagReasons
Order represents a customer's intent to purchase a specific set of products from your platform. Here platform could be a Website, POS machine, External integrations etc. It typically includes details like customer information, billing/shipping addresses, items ordered, quantities, pricing, and chosen fulfillment method. Meta of an order can be edited.
Operations
GET
# List customer orders
GET
# Get an order
GET
# Retrieves POS order details
Parameters
statusquery
integer
A filter to retrieve orders by their current status such as 'placed', 'delivered' etc.
page_noquery
integer
The page number to navigate through the given set of results. Default value is 1.
page_sizequery
integer
The number of items to retrieve in each page. Default value is 10.
from_datequery
string
Start date for filtering orders. Format: MM-DD-YYYY, e.g. '04-15-2026' for April 15, 2026.
to_datequery
string
End date for filtering orders. Format: MM-DD-YYYY, e.g. '05-15-2026' for May 15, 2026.
start_datequery
string
Start date for filtering orders by UTC creation date. Format: MM-DD-YYYY, e.g. '04-15-2026' for April 15, 2026.
end_datequery
string
End date for filtering orders by UTC creation date. Format: MM-DD-YYYY, e.g. '05-15-2026' for May 15, 2026.
start_datetimequery
string
| date-time
Start of the order created datetime range. ISO-8601 with an explicit timezone offset (e.g. '2026-04-15T16:00:00Z' or '2026-04-15T16:00:00+08:00'). Must be sent together with end_datetime; date-only or offset-less values are rejected. Use this when timezone-aligned hour-precision filtering is required.
end_datetimequery
string
| date-time
End of the order created datetime range. ISO-8601 with an explicit timezone offset, same shape as start_datetime. Must be sent together with start_datetime; date-only or offset-less values are rejected.
custom_metaquery
string
A filter and retrieve data using special fields included for special use-cases.
Default Value : 6388422a5ebd6a6cf4a8ede6
allow_inactivequery
boolean
Flag indicating whether inactive shipments are allowed.
Default Value : false
GET
Response
200
Success. Returns all the orders.
Hide
Schema for order listing.
page
object (OrderPage)
Show
Schema for order's pagination.
type
string
Specifies type of pagination. If it is 'cursor' based or 'number' based.
item_total
integer
Total number of items available across all pages. It provides a count of all the items that match the query criteria, regardless of pagination.
current
integer
Specifies the current page number. It helps in identifying the position within the paginated results.
size
integer
Represents the number of items on the current page. It indicates how many items are included in each page of the paginated response.
has_next
boolean
Indicates whether there is a next page available. It is true if a next page exists and false if the current page is the last one.
items
array of object (OrderInfo)
List of orders, each containing detailed information about individual orders and their respective shipments.
Show
Schema for Order related information.
order_created_time
string
The date and time when the order was created.
order_created_ts
string
The date-time when the order was created in ISO format and UTC timezone.
total_shipments_in_order
integer
The total number of shipments in the order.
order_id
string
The unique identifier for the order.
breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (BreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
shipments
array of object (ShipmentInfo)
An array containing details of individual shipments within the order.
Show
Shipment information Schema.
order_id
string
The unique identifier for the order.
breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (BreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
beneficiary_details
boolean
Indicates if there are any beneficiary details.
shipment_created_at
string
| date-time
The date and time when the shipment was created.
shipment_created_ts
string
The date-time when the shipment was created in ISO format and UTC timezone.
shipment_id
string
The unique identifier for the shipment.
affiliate_shipment_id
string
External shipment ID provided by the sales channel or the extension.
shipment_status
object (ShipmentStatus)
Show
Schema for shipment status.
value
string
Nullable
The internal or code value representing the shipment status.
title
string
The title or display name representing the shipment status.
hex_code
string
The hexadecimal color code associated with the shipment status. Each state of a shipment (like "processing", "cancelled", "delivered", etc.) is associated with a unique color, represented by a hex code. This color coding makes it visually intuitive for users to understand the status of their shipment at a glance.
track_url
string
The URL for tracking the shipment.
traking_no
string
The tracking number for the shipment.
awb_no
string
The airway bill number for the shipment.
dp_name
string
The name of the delivery partner.
tracking_details
array of object (TrackingDetails)
An array containing details of the tracking history of the shipment.
Show
Schema for tracking details.
value
string
Nullable
Current value or state of the process.
is_current
boolean
Indicates whether the tracking event is the current or active status.
is_passed
boolean
Indicates whether the tracking event has passed or occurred.
status
string
The status of the tracking event.
time
string
The time associated with the tracking event.
created_ts
string
Timestamp when this status was created.
tracking_details
array of object (NestedTrackingDetails)
Nested tracking details.
Show
Schema for nested tracking details.
is_passed
boolean
Indicates whether the tracking event has passed or occurred.
time
string
The time associated with the tracking event.
is_current
boolean
Indicates whether the tracking event is the current or active status.
status
string
The status of the tracking event.
total_bags
integer
The total number of bags in the shipment.
bags
array of object (Bags)
An array containing details about the individual bags in the shipment.
Show
Bag details.
delivery_date
string
| date-time
Nullable
The date and time when the item is expected to be delivered.
line_number
integer
The line number of the item in the order.
currency_symbol
string
The symbol of the currency used.
item
object (Item)
Show
Schema for item.
image
array of string
An array of URLs pointing to images of the item.
l1_categories
array of string
An array of level 1 categories to which the item belongs.
l2_category
array of string
An array of level 2 categories to which the item belongs.
l2_category_id
number
ID representing the level 2 category classification of the item
brand
object (ItemBrand)
Show
Schema for brand within item.
logo
string
The URL of the brand's logo.
name
string
The name of the brand.
seller_identifier
string
The identifier for the seller.
code
string
The code or SKU of the item.
id
number
The unique identifier of the item.
name
string
The name of the item.
l3_category_name
string
This key specifies the name of the third-level category under which the product is listed, offering a more detailed classification within the e-commerce platform's hierarchy.
slug_key
string
A unique key or identifier for the item slug.
l2_categories
array of string
An array of level 2 categories the item belongs to.
size
string
The size of the item.
attributes
object
An object containing various attributes of the item.
applied_promos
array of object (AppliedPromos)
An array containing information about applied promotions.
Show
Schema for applied promos.
mrp_promotion
boolean
Indicates if the promotion is applied to the MRP.
promotion_name
string
The name of the promotion.
article_quantity
number
The quantity of articles required to qualify for the promotion.
promo_id
string
The unique identifier for the promotion.
amount
number
The discount amount provided by the promotion.
promotion_type
string
Specifies the type of discount or deal applied to the current promotion, defining how the promotion modifies the price or adds value to the purchase. Each type represents a different promotional strategy - percentage- Discount by a percentage of the original price. - amount- Discount by a specific amount off the original price. - fixed_price- Sets the price to a specific fixed amount. - bogo- Buy One Get One or at a discount. - contract_price- Special pricing based on a contract or agreement. - shipping_price- Discount or deal related to the shipping cost. - ladder_price- Price changes based on quantity purchased. - bundle_price_percentage- Discount on a bundle purchase by a percentage. - bundle_price_amount- Discount on a bundle purchase by a specific amount. - bundle_amount_percentage- A percentage of the purchase amount is applied as a discount when buying in a bundle. - custom- A custom promotion not covered by other types. - free_gift_items- Free gift items are included with the purchase. - free_non_sellable_items- Free items that are not for sale are included with the purchase. - item_based_discount- Specific percentage discounts on selected items based on their position after sorting by price in descending order.
Enum
applied_free_articles
array of object (AppliedFreeArticles)
An array containing details of free articles applied under the promotion.
Show
Schema for applied free articles.
article_id
string
The unique identifier for the article.
free_gift_item_details
object
An object containing details about the free gift item.
parent_item_identifier
string
The identifier for the parent item to which this free article is related.
quantity
number
The quantity of the free article.
quantity
integer
The quantity of the item.
prices
object (Prices)
Show
Schema for prices.
delivery_charge
number
The delivery charge for the order.
coupon_value
number
The value of the coupon applied.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
currency_symbol
string
The symbol of the currency used.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
promotion_effective_discount
number
The effective discount from promotions.
refund_amount
number
The amount refunded to the customer.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
can_cancel
boolean
Indicates if the item can be canceled.
can_return
boolean
Indicates if the item can be returned.
id
integer
The unique identifier for the order item.
returnable_date
string
| date-time
Nullable
The last date and time by which the item can be returned.
financial_breakup
array of object (FinancialBreakup)
An array containing financial details of the item.
Show
Financial breakup object.
coupon_value
number
The value of the coupon applied.
delivery_charge
number
The delivery charge for the order.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods. It is used in trade and commerce to identify products and services uniformly across different countries and industries. The system was developed by the World Customs Organization (WCO) and is widely used in customs processes and tax systems.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
size
string
The size of the item.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
total_units
integer
The total number of units purchased.
identifiers
object (Identifiers)
Show
An object containing identification details for the item.
ean
string
The European Article Number (EAN) of the item.
sku_code
string
The Stock Keeping Unit (SKU) code of the item - uniquely identifies each distinct product. SKUs are used to track inventory levels, facilitate accurate stocktaking, and streamline order fulfillment processes. This code is essential for inventory management, allowing for the differentiation between products based on attributes such as price, color, and size.
gst_tag
string
The GST tag indicating the type of GST applied.
item_name
string
The name of the item.
promotion_effective_discount
number
The effective discount from promotions.
gst_fee
number
The GST fee applied to the item.
refund_amount
number
The amount refunded to the customer.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Schema for Tax Component.
name
string
Name of tax component.
rate
number
Applied tax rate.
tax_amount
number
Tax Amount.
taxable_amount
number
Taxable Amount (Amount Without Tax).
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
parent_promo_bags
object
An object containing details of parent promotional bags.
meta
object
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
seller_identifier
string
The identifier for the seller.
current_status
object (CurrentStatus)
Show
Current status details.
updated_at
string
| date-time
The date and time when the status was last updated.
name
string
The name or label indicating the current state or status.
status
string
The current status of the bag.
journey_type
string
Nullable
It is a type being used to represent the journey of shipment through the performed status transition. Forward Journey: The forward journey encompasses all the stages of shipping, including order placement, packing, dispatch, in-transit updates, and delivery. Return Journey: Contrary to the forward journey, the return journey involves the process of sending items back from the customer to the original sender or a designated return facility.
Enum
article
object (Article)
Nullable
Show
Schema for article.
tags
array of string
An array of tags associated with the article.
charges
array of object (PriceAdjustmentCharge)
An array of charges associated with the order item.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
is_bundle_item
boolean
Flag to indicate whether the bag is part of a bundle.
bundle_details
object (BundleDetails)
Show
Contains bundle-related metadata for the shipment.
bundle_group_id
string
Unique group identifier for the bundle.
name
string
Name of the bundle.
slug
string
URL-friendly identifier for the bundle.
bundle_count
integer
Indicates bundle count of the bag.
article_bundle_id
string
Unique identifier for the article bundle.
bundle_article_quantity
integer
Article net_quantity in bundle Product.
is_base
boolean
Indicates if the item is a base item.
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 (BundleReturnConfig)
Show
Refund Config for bundle product
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
Seller Identifier of the bundle.
images
array of string
An array of image URLs associated with the bundle.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
size_info
object
An object containing size information for the items in the shipment.
order_type
string
Nullable
Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example:
- "HomeDelivery": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address.
- "PickAtStore": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person.
- "Digital": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically.
Enum
fulfilling_store
object (FulfillingStore)
Show
Schema for fulfilling store.
id
integer
The unique identifier of the store.
code
string
A code associated with the store.
name
string
The name of the store.
company_name
string
The name of the company associated with the store.
company_id
integer
The identifier of the company associated with the store.
fulfilling_company
object (FulfillingCompany)
Show
Fulfilling company details.
id
integer
The unique identifier for the fulfilling company.
name
string
The name of the fulfilling company.
charges
array of object (PriceAdjustmentCharge)
An array of charge objects associated with the shipment.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
total_details
object (ShipmentTotalDetails)
Show
Schema for shipment total details.
pieces
integer
The total number of pieces included.
total_price
number
The total price of the order or item.
sizes
integer
The number of different sizes included.
promise
object (Promise)
Show
Schema for promise.
show_promise
boolean
Indicates whether the promise details should be shown.
timestamp
object (TimeStampData)
Show
Schema for time stamp data.
min
string
The minimum timestamp value.
max
string
The maximum timestamp value.
delivery_date
string
| date-time
Nullable
The expected delivery date.
billing_address
object (Address)
Show
An object containing the address details.
pincode
string
The postal code of the address.
phone
string
The phone number of the person associated with the address.
latitude
number
Nullable
The latitude coordinate.
address2
string
The secondary line of the address.
landmark
string
A nearby landmark.
area
string
The area or locality.
city
string
The city of the address.
address
string
The full address.
address_type
string
The type of the address (e.g., home, office).
Enum
longitude
number
Nullable
The longitude coordinate.
country_iso_code
string
The ISO code for the country.
state
string
The state of the address.
created_at
string
| date-time
The date and time when the address was created.
address1
string
The primary line of the address.
display_address
string
The formatted display address, typically used for printing or displaying in user interfaces.
name
string
The name of the person associated with the address.
contact_person
string
The name of the contact person.
address_category
string
Category or classification of the address. The address_category field
that includes "store", "delivery", and "billing" serves to classify
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy.
Enum
email
string
The email address.
country_phone_code
string
The country phone code.
version
string
The version of the address format.
updated_at
string
| date-time
The date and time when the address was last updated.
country
string
The country of the address.
delivery_address
object (Address)
Show
An object containing the address details.
pincode
string
The postal code of the address.
phone
string
The phone number of the person associated with the address.
latitude
number
Nullable
The latitude coordinate.
address2
string
The secondary line of the address.
landmark
string
A nearby landmark.
area
string
The area or locality.
city
string
The city of the address.
address
string
The full address.
address_type
string
The type of the address (e.g., home, office).
Enum
longitude
number
Nullable
The longitude coordinate.
country_iso_code
string
The ISO code for the country.
state
string
The state of the address.
created_at
string
| date-time
The date and time when the address was created.
address1
string
The primary line of the address.
display_address
string
The formatted display address, typically used for printing or displaying in user interfaces.
name
string
The name of the person associated with the address.
contact_person
string
The name of the contact person.
address_category
string
Category or classification of the address. The address_category field
that includes "store", "delivery", and "billing" serves to classify
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy.
Enum
email
string
The email address.
country_phone_code
string
The country phone code.
version
string
The version of the address format.
updated_at
string
| date-time
The date and time when the address was last updated.
country
string
The country of the address.
can_cancel
boolean
Indicates if the shipment can be canceled.
can_return
boolean
Indicates if the shipment can be returned.
returnable_date
string
| date-time
Nullable
The last date by which the item can be returned.
show_track_link
boolean
Indicates if the track link should be shown.
prices
object (Prices)
Show
Schema for prices.
delivery_charge
number
The delivery charge for the order.
coupon_value
number
The value of the coupon applied.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
currency_symbol
string
The symbol of the currency used.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
promotion_effective_discount
number
The effective discount from promotions.
refund_amount
number
The amount refunded to the customer.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
can_break
object
Indicates whether a shipment can be split or broken down at specific stages of the shipment lifecycle. Specifies whether breaking the shipment is allowed.
need_help_url
string
The URL for customer support or help.
show_download_invoice
boolean
Indicates if the download invoice option should be shown.
payment
object (ShipmentPayment)
Show
An object containing payment details.
mop
string
Abbreviation or code for the payment mode.
payment_mode
string
The specific payment mode used.
status
string
The current status of the payment.
mode
string
The payment mode.
logo
string
URL of the logo representing the payment mode.
display_name
string
The name to be displayed for the payment mode.
user_info
object (ShipmentUserInfo)
Show
Schema for shipments user info.
first_name
string
The unique identifier of the store.
gender
string
A code associated with the store.
name
string
The name of the store.
last_name
string
The name of the company associated with the store.
mobile
string
The identifier of the company associated with the store.
email
string
Email address of the user.
comment
string
Any comments related to the shipment.
invoice
object (Invoice)
Show
Schema for invoice.
invoice_url
string
URL providing access to the invoice.
updated_date
string
| date-time
The date and time when the invoice was last updated.
label_url
string
URL providing access to the invoice label.
refund_details
object
An object containing details of any refunds.
payment_info
array of object (ShipmentPaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Show
Array of objects containing shipment payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
mop
string
Stands for "Mode of Payment". This is a short code (like "COD" for Cash On Delivery) that represents the payment method used.
payment_mode
string
Information about the payment mode, indicates whether COD or PREPAID.
status
string
Indicates the current status of the payment, Paid or Unpaid.
mode
string
Information about the payment source. For eg, NB_ICICI.
logo
string
A URL to an image representing the payment method.
display_name
string
The name of the payment method as it should be displayed to the user.
amount
number
Amount paid using this payment method.
fulfillment_option
object (FulfillmentOption)
Show
Delivery service option with type, name, and default status.
slug
string
Unique identifier for the delivery type.
is_default
boolean
Indicates if this is the default delivery option.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
ndr_details
object (NdrDetailsSchema)
Show
Schema containig NDR related data pointers.
show_ndr_form
boolean
A boolean flag represent whether NDR form needs to be displayed or not.
non_editable_address_fields
array of string
A list of address fields that are not allowed to be updated while filling NDR form.
delivery_scheduled_date
string
| date-time
The scheduled date and time when the delivery reattempt is expected to take place. This value is selected by the customer during the NDR (Non-Delivery Report) flow, and is intended to guide the courier partner on when to attempt redelivery.
allowed_delivery_window
object (NdrDeliveryWindowSchema)
Show
Schema for NDR delivery window.
start_date
string
| date-time
The start date from which a customer can select to reattempt the delivery of a shipment.
end_date
string
| date-time
The end date till which a customer can is allowed to reattempt the delivery of a shipment.
excluded_dates
array of string
A list of dates which needs to be excluded from the range provided by start_date and end_date.
failure_reason
string
The reason recorded by the courier or delivery partner for the failed delivery attempt. This is typically selected or entered at the time of delivery when the attempt was unsuccessful. For example, "Customer not available", "Address not found", or "Premises closed".
delivery_partner_remarks
string
Any extra notes or observations added by the delivery partner at the time of a failed delivery attempt.
customer_remarks
string
Additional comments provided by the customer while rescheduling the delivery.
charges
array of object (PriceAdjustmentCharge)
An array containing details of bags available for reorder.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
bags_for_reorder
array of object (BagsForReorder)
Items to be added to the cart when reordering a previous purchase.
Show
An array containing details of bags available for reorder.
item_size
string
The size of the item.
quantity
integer
The quantity of the item.
store_id
integer
The identifier for the store.
article_assignment
object (BagsForReorderArticleAssignment)
Show
An object containing details about the assignment of articles.
strategy
string
The strategy used for article assignment.
level
string
The level at which the article assignment is made.
seller_id
integer
The identifier for the seller.
item_id
integer
The unique identifier for the item.
meta
object
A field to store additional metadata related to the courier partner's operations or the shipment.
gstin_code
string
A GST Number (Goods and Services Tax Identification Number, often abbreviated as GSTIN) is a unique identifier assigned to a business or individual registered under the Goods and Services Tax (GST) system in countries like India. The GST number is essential for businesses to comply with tax regulations and for the government to track tax payments and returns.
user_info
object (UserDetails)
Show
User Details.
first_name
string
First name of the user.
gender
string
Gender of the user.
last_name
string
Last name of the user.
mobile
string
Mobile number of the user.
filters
object (OrderFilters)
Show
Order filters.
statuses
array of object (OrderStatuses)
An array containing the order statuses.
Show
An array containing the order statuses.
value
integer
The value representing the selection.
is_selected
boolean
Indicates whether this option is currently selected.
display
string
The text to display.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
page_no:
1
Response
List customer orders
getOrders
Get order details such as tracking details, shipment, store information using Fynd Order ID.
Parameters
order_idpath
string
Required
A unique number used for identifying and tracking an order.
allow_inactivequery
boolean
Flag to allow inactive shipments.
Default Value : false
GET
Response
200
Success.
Hide
Schema for Order Details.
order
object (OrderSchema)
Show
Schema for Order Details.
total_shipments_in_order
integer
The total number of shipments in the order.
gstin_code
string
A GST Number (Goods and Services Tax Identification Number, often abbreviated as GSTIN) is a unique identifier assigned to a business or individual registered under the Goods and Services Tax (GST) system in countries like India. The GST number is essential for businesses to comply with tax regulations and for the government to track tax payments and returns.
user_info
object (UserInfo)
Show
User Info.
first_name
string
First name of the user.
gender
string
Gender of the user.
name
string
Full name of the user (including first and last names).
last_name
string
Last name of the user.
mobile
string
Mobile number of the user.
email
string
Email address of the user.
breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (BreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
order_created_time
string
The date and time when the order was created.
order_created_ts
string
The timestamp when the order was created.
order_id
string
The unique identifier for the order.
shipments
array of object (Shipments)
An array containing details of individual shipments within the order.
Show
Shipment details Schema.
payment
object (ShipmentPayment)
Show
An object containing payment details.
mop
string
Abbreviation or code for the payment mode.
payment_mode
string
The specific payment mode used.
status
string
The current status of the payment.
mode
string
The payment mode.
logo
string
URL of the logo representing the payment mode.
display_name
string
The name to be displayed for the payment mode.
payment_info
array of object (ShipmentPaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Show
Array of objects containing shipment payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
mop
string
Stands for "Mode of Payment". This is a short code (like "COD" for Cash On Delivery) that represents the payment method used.
payment_mode
string
Information about the payment mode, indicates whether COD or PREPAID.
status
string
Indicates the current status of the payment, Paid or Unpaid.
mode
string
Information about the payment source. For eg, NB_ICICI.
logo
string
A URL to an image representing the payment method.
display_name
string
The name of the payment method as it should be displayed to the user.
amount
number
Amount paid using this payment method.
order_type
string
Nullable
Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example:
- "HomeDelivery": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address.
- "PickAtStore": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person.
- "Digital": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically.
Enum
gstin_code
string
A GST Number (Goods and Services Tax Identification Number, often abbreviated as GSTIN) is a unique identifier assigned to a business or individual registered under the Goods and Services Tax (GST) system in countries like India. The GST number is essential for businesses to comply with tax regulations and for the government to track tax payments and returns.
show_download_invoice
boolean
Indicates if the download invoice option should be shown.
can_cancel
boolean
Indicates if the shipment can be canceled.
user_info
object (ShipmentUserInfo)
Show
Schema for shipments user info.
first_name
string
The unique identifier of the store.
gender
string
A code associated with the store.
name
string
The name of the store.
last_name
string
The name of the company associated with the store.
mobile
string
The identifier of the company associated with the store.
email
string
Email address of the user.
shipment_id
string
The unique identifier for the shipment.
affiliate_shipment_id
string
External shipment ID provided by the sales channel or the extension.
fulfilling_store
object (FulfillingStore)
Show
Schema for fulfilling store.
id
integer
The unique identifier of the store.
code
string
A code associated with the store.
name
string
The name of the store.
company_name
string
The name of the company associated with the store.
company_id
integer
The identifier of the company associated with the store.
custom_meta
array of object
An object containing custom metadata for the shipment.
shipment_status
object (ShipmentStatus)
Show
Schema for shipment status.
value
string
Nullable
The internal or code value representing the shipment status.
title
string
The title or display name representing the shipment status.
hex_code
string
The hexadecimal color code associated with the shipment status. Each state of a shipment (like "processing", "cancelled", "delivered", etc.) is associated with a unique color, represented by a hex code. This color coding makes it visually intuitive for users to understand the status of their shipment at a glance.
comment
string
Any comments related to the shipment.
invoice
object (Invoice)
Show
Schema for invoice.
invoice_url
string
URL providing access to the invoice.
updated_date
string
| date-time
The date and time when the invoice was last updated.
label_url
string
URL providing access to the invoice label.
credit_note
object (CreditNote)
Show
It contains credit note related data pointers like credit note id, credit note pdf url, etc.
credit_note_id
string
Nullable
The identifier for any credit note issued for the shipment.
credit_note_url
string
Nullable
Pre-signed URL to download the credit note PDF document generated for the shipment.
show_track_link
boolean
Indicates if the track link should be shown.
refund_details
object
An object containing details of any refunds.
breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (BreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
can_break
object
Indicates whether a shipment can be split or broken down at specific stages of the shipment lifecycle. Specifies whether breaking the shipment is allowed.
traking_no
string
The tracking number for the shipment.
tracking_details
array of object (TrackingDetails)
An array containing details of the tracking history of the shipment.
Show
Schema for tracking details.
value
string
Nullable
Current value or state of the process.
is_current
boolean
Indicates whether the tracking event is the current or active status.
is_passed
boolean
Indicates whether the tracking event has passed or occurred.
status
string
The status of the tracking event.
time
string
The time associated with the tracking event.
created_ts
string
Timestamp when this status was created.
tracking_details
array of object (NestedTrackingDetails)
Nested tracking details.
Show
Schema for nested tracking details.
is_passed
boolean
Indicates whether the tracking event has passed or occurred.
time
string
The time associated with the tracking event.
is_current
boolean
Indicates whether the tracking event is the current or active status.
status
string
The status of the tracking event.
promise
object (Promise)
Show
Schema for promise.
show_promise
boolean
Indicates whether the promise details should be shown.
timestamp
object (TimeStampData)
Show
Schema for time stamp data.
min
string
The minimum timestamp value.
max
string
The maximum timestamp value.
total_bags
integer
The total number of bags in the shipment.
total_details
object (ShipmentTotalDetails)
Show
Schema for shipment total details.
pieces
integer
The total number of pieces included.
total_price
number
The total price of the order or item.
sizes
integer
The number of different sizes included.
prices
object (Prices)
Show
Schema for prices.
delivery_charge
number
The delivery charge for the order.
coupon_value
number
The value of the coupon applied.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
currency_symbol
string
The symbol of the currency used.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
promotion_effective_discount
number
The effective discount from promotions.
refund_amount
number
The amount refunded to the customer.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
returnable_date
string
| date-time
Nullable
The last date by which the item can be returned.
shipment_created_at
string
| date-time
The date and time when the shipment was created.
shipment_created_ts
string
The timestamp when the shipment was created.
size_info
object
An object containing size information for the items in the shipment.
bags
array of object (Bags)
An array containing details about the individual bags in the shipment.
Show
Bag details.
delivery_date
string
| date-time
Nullable
The date and time when the item is expected to be delivered.
line_number
integer
The line number of the item in the order.
currency_symbol
string
The symbol of the currency used.
item
object (Item)
Show
Schema for item.
image
array of string
An array of URLs pointing to images of the item.
l1_categories
array of string
An array of level 1 categories to which the item belongs.
l2_category
array of string
An array of level 2 categories to which the item belongs.
l2_category_id
number
ID representing the level 2 category classification of the item
brand
object (ItemBrand)
Show
Schema for brand within item.
logo
string
The URL of the brand's logo.
name
string
The name of the brand.
seller_identifier
string
The identifier for the seller.
code
string
The code or SKU of the item.
id
number
The unique identifier of the item.
name
string
The name of the item.
l3_category_name
string
This key specifies the name of the third-level category under which the product is listed, offering a more detailed classification within the e-commerce platform's hierarchy.
slug_key
string
A unique key or identifier for the item slug.
l2_categories
array of string
An array of level 2 categories the item belongs to.
size
string
The size of the item.
attributes
object
An object containing various attributes of the item.
applied_promos
array of object (AppliedPromos)
An array containing information about applied promotions.
Show
Schema for applied promos.
mrp_promotion
boolean
Indicates if the promotion is applied to the MRP.
promotion_name
string
The name of the promotion.
article_quantity
number
The quantity of articles required to qualify for the promotion.
promo_id
string
The unique identifier for the promotion.
amount
number
The discount amount provided by the promotion.
promotion_type
string
Specifies the type of discount or deal applied to the current promotion, defining how the promotion modifies the price or adds value to the purchase. Each type represents a different promotional strategy - percentage- Discount by a percentage of the original price. - amount- Discount by a specific amount off the original price. - fixed_price- Sets the price to a specific fixed amount. - bogo- Buy One Get One or at a discount. - contract_price- Special pricing based on a contract or agreement. - shipping_price- Discount or deal related to the shipping cost. - ladder_price- Price changes based on quantity purchased. - bundle_price_percentage- Discount on a bundle purchase by a percentage. - bundle_price_amount- Discount on a bundle purchase by a specific amount. - bundle_amount_percentage- A percentage of the purchase amount is applied as a discount when buying in a bundle. - custom- A custom promotion not covered by other types. - free_gift_items- Free gift items are included with the purchase. - free_non_sellable_items- Free items that are not for sale are included with the purchase. - item_based_discount- Specific percentage discounts on selected items based on their position after sorting by price in descending order.
Enum
applied_free_articles
array of object (AppliedFreeArticles)
An array containing details of free articles applied under the promotion.
Show
Schema for applied free articles.
article_id
string
The unique identifier for the article.
free_gift_item_details
object
An object containing details about the free gift item.
parent_item_identifier
string
The identifier for the parent item to which this free article is related.
quantity
number
The quantity of the free article.
quantity
integer
The quantity of the item.
prices
object (Prices)
Show
Schema for prices.
delivery_charge
number
The delivery charge for the order.
coupon_value
number
The value of the coupon applied.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
currency_symbol
string
The symbol of the currency used.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
promotion_effective_discount
number
The effective discount from promotions.
refund_amount
number
The amount refunded to the customer.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
can_cancel
boolean
Indicates if the item can be canceled.
can_return
boolean
Indicates if the item can be returned.
id
integer
The unique identifier for the order item.
returnable_date
string
| date-time
Nullable
The last date and time by which the item can be returned.
financial_breakup
array of object (FinancialBreakup)
An array containing financial details of the item.
Show
Financial breakup object.
coupon_value
number
The value of the coupon applied.
delivery_charge
number
The delivery charge for the order.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods. It is used in trade and commerce to identify products and services uniformly across different countries and industries. The system was developed by the World Customs Organization (WCO) and is widely used in customs processes and tax systems.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
size
string
The size of the item.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
total_units
integer
The total number of units purchased.
identifiers
object (Identifiers)
Show
An object containing identification details for the item.
ean
string
The European Article Number (EAN) of the item.
sku_code
string
The Stock Keeping Unit (SKU) code of the item - uniquely identifies each distinct product. SKUs are used to track inventory levels, facilitate accurate stocktaking, and streamline order fulfillment processes. This code is essential for inventory management, allowing for the differentiation between products based on attributes such as price, color, and size.
gst_tag
string
The GST tag indicating the type of GST applied.
item_name
string
The name of the item.
promotion_effective_discount
number
The effective discount from promotions.
gst_fee
number
The GST fee applied to the item.
refund_amount
number
The amount refunded to the customer.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Schema for Tax Component.
name
string
Name of tax component.
rate
number
Applied tax rate.
tax_amount
number
Tax Amount.
taxable_amount
number
Taxable Amount (Amount Without Tax).
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
parent_promo_bags
object
An object containing details of parent promotional bags.
meta
object
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
seller_identifier
string
The identifier for the seller.
current_status
object (CurrentStatus)
Show
Current status details.
updated_at
string
| date-time
The date and time when the status was last updated.
name
string
The name or label indicating the current state or status.
status
string
The current status of the bag.
journey_type
string
Nullable
It is a type being used to represent the journey of shipment through the performed status transition. Forward Journey: The forward journey encompasses all the stages of shipping, including order placement, packing, dispatch, in-transit updates, and delivery. Return Journey: Contrary to the forward journey, the return journey involves the process of sending items back from the customer to the original sender or a designated return facility.
Enum
article
object (Article)
Nullable
Show
Schema for article.
tags
array of string
An array of tags associated with the article.
charges
array of object (PriceAdjustmentCharge)
An array of charges associated with the order item.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
is_bundle_item
boolean
Flag to indicate whether the bag is part of a bundle.
bundle_details
object (BundleDetails)
Show
Contains bundle-related metadata for the shipment.
bundle_group_id
string
Unique group identifier for the bundle.
name
string
Name of the bundle.
slug
string
URL-friendly identifier for the bundle.
bundle_count
integer
Indicates bundle count of the bag.
article_bundle_id
string
Unique identifier for the article bundle.
bundle_article_quantity
integer
Article net_quantity in bundle Product.
is_base
boolean
Indicates if the item is a base item.
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 (BundleReturnConfig)
Show
Refund Config for bundle product
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
Seller Identifier of the bundle.
images
array of string
An array of image URLs associated with the bundle.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
dp_name
string
The name of the delivery partner.
awb_no
string
The airway bill number for the shipment.
beneficiary_details
boolean
Indicates if there are any beneficiary details.
fulfilling_company
object (FulfillingCompany)
Show
Fulfilling company details.
id
integer
The unique identifier for the fulfilling company.
name
string
The name of the fulfilling company.
can_return
boolean
Indicates if the shipment can be returned.
delivery_address
object (Address)
Show
An object containing the address details.
pincode
string
The postal code of the address.
phone
string
The phone number of the person associated with the address.
latitude
number
Nullable
The latitude coordinate.
address2
string
The secondary line of the address.
landmark
string
A nearby landmark.
area
string
The area or locality.
city
string
The city of the address.
address
string
The full address.
address_type
string
The type of the address (e.g., home, office).
Enum
longitude
number
Nullable
The longitude coordinate.
country_iso_code
string
The ISO code for the country.
state
string
The state of the address.
created_at
string
| date-time
The date and time when the address was created.
address1
string
The primary line of the address.
display_address
string
The formatted display address, typically used for printing or displaying in user interfaces.
name
string
The name of the person associated with the address.
contact_person
string
The name of the contact person.
address_category
string
Category or classification of the address. The address_category field
that includes "store", "delivery", and "billing" serves to classify
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy.
Enum
email
string
The email address.
country_phone_code
string
The country phone code.
version
string
The version of the address format.
updated_at
string
| date-time
The date and time when the address was last updated.
country
string
The country of the address.
billing_address
object (Address)
Show
An object containing the address details.
pincode
string
The postal code of the address.
phone
string
The phone number of the person associated with the address.
latitude
number
Nullable
The latitude coordinate.
address2
string
The secondary line of the address.
landmark
string
A nearby landmark.
area
string
The area or locality.
city
string
The city of the address.
address
string
The full address.
address_type
string
The type of the address (e.g., home, office).
Enum
longitude
number
Nullable
The longitude coordinate.
country_iso_code
string
The ISO code for the country.
state
string
The state of the address.
created_at
string
| date-time
The date and time when the address was created.
address1
string
The primary line of the address.
display_address
string
The formatted display address, typically used for printing or displaying in user interfaces.
name
string
The name of the person associated with the address.
contact_person
string
The name of the contact person.
address_category
string
Category or classification of the address. The address_category field
that includes "store", "delivery", and "billing" serves to classify
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy.
Enum
email
string
The email address.
country_phone_code
string
The country phone code.
version
string
The version of the address format.
updated_at
string
| date-time
The date and time when the address was last updated.
country
string
The country of the address.
track_url
string
The URL for tracking the shipment.
order_id
string
The unique identifier for the order.
need_help_url
string
The URL for customer support or help.
return_meta
object
An object containing metadata about the return process.
delivery_date
string
| date-time
Nullable
The expected delivery date.
order
object (OrderRequestSchema)
Show
An object containing meta-information about the order.
meta
object
Metadata for the order.
charges
array of object (PriceAdjustmentCharge)
An array of charge objects associated with the shipment.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
fulfillment_option
object (FulfillmentOption)
Show
Delivery service option with type, name, and default status.
slug
string
Unique identifier for the delivery type.
is_default
boolean
Indicates if this is the default delivery option.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
ndr_details
object (NdrDetailsSchema)
Show
Schema containig NDR related data pointers.
show_ndr_form
boolean
A boolean flag represent whether NDR form needs to be displayed or not.
non_editable_address_fields
array of string
A list of address fields that are not allowed to be updated while filling NDR form.
delivery_scheduled_date
string
| date-time
The scheduled date and time when the delivery reattempt is expected to take place. This value is selected by the customer during the NDR (Non-Delivery Report) flow, and is intended to guide the courier partner on when to attempt redelivery.
allowed_delivery_window
object (NdrDeliveryWindowSchema)
Show
Schema for NDR delivery window.
start_date
string
| date-time
The start date from which a customer can select to reattempt the delivery of a shipment.
end_date
string
| date-time
The end date till which a customer can is allowed to reattempt the delivery of a shipment.
excluded_dates
array of string
A list of dates which needs to be excluded from the range provided by start_date and end_date.
failure_reason
string
The reason recorded by the courier or delivery partner for the failed delivery attempt. This is typically selected or entered at the time of delivery when the attempt was unsuccessful. For example, "Customer not available", "Address not found", or "Premises closed".
delivery_partner_remarks
string
Any extra notes or observations added by the delivery partner at the time of a failed delivery attempt.
customer_remarks
string
Additional comments provided by the customer while rescheduling the delivery.
refund_modes
array of object (RefundModeData)
List of refund modes applicable to the shipment.
Show
Refund Mode applied to the shipment.
identifier
string
Unique identifier for the refund mode instance
amount_paid
number
Amount that was originally paid
refund_amount
number
Amount to be refunded
refund_status
object (RefundStatus)
Show
Refund Status
id
string
Unique identifier for the refund status.
status
string
Descriptive status of the refund (e.g., refund_acknowledged, refund_approved).
operational_status
string
Display Status for the storefront its pending when refund is in progress and completed when refund completed for a mode
transaction_info
array of object (RefundTransactionInfo)
Refund Status Transaction Info for the payment mode
Show
Represents transaction-level identifiers associated with a refund of a payment mode/Methods.
rrn
string
Refund Reference Number (RRN) generated for the refund transaction.
utr
string
Unique Transaction Reference (UTR) for the refund.
mode
string
Payment mode for which the refund was processed. Please refer for detailed Payment Mode.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_ts
string
Timestamp when the refund status was created.
updated_ts
string
Timestamp when the refund status was last updated.
updated_by
string
Identifier for the user or process that last updated the refund status.
remarks
string
Additional remarks or notes
beneficiary_details
object (BeneficiaryDetails)
Show
Details of the bank beneficiary to whom the refund will be made.
account_holder
string
Name of the account holder
account_no
string
Bank account number (may be masked)
bank_name
string
Name of the bank
beneficiary_id
string
Encrypted/encoded beneficiary identifier
branch_name
string
Bank branch name
is_verified
boolean
Whether the beneficiary details are verified
vpa_address
string
VPA Address of the customer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
meta
object
Additional metadata
refund_mode
string
Method of refund processing
logo
string
Refund Mode logo.
display_name
string
Human-readable name for the refund mode
payment_identifiers
array of string
Additional payment information
operational_status
string
Display Status for the storefront its pending when refund is in progress and completed when refund completed for a mode
transaction_data
object
Refund Status Transaction Data
default_refund_mode
boolean
Indicates that the system assigned a default refund mode when no refund mode is chosen during the return/refund process.
refund_breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (BreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
is_refund_config_enabled
boolean
Indicates whether refund configuration is enabled for the sales channel; if disabled, no refund options are shown, and if enabled, the applicable refund modes are displayed.
meta
object
Client-defined shipment-level metadata. The structure is flexible and interpretation is the client’s responsibility.
bags_for_reorder
array of object (BagsForReorder)
Items to be added to the cart when reordering a previous purchase.
Show
An array containing details of bags available for reorder.
item_size
string
The size of the item.
quantity
integer
The quantity of the item.
store_id
integer
The identifier for the store.
article_assignment
object (BagsForReorderArticleAssignment)
Show
An object containing details about the assignment of articles.
strategy
string
The strategy used for article assignment.
level
string
The level at which the article assignment is made.
seller_id
integer
The identifier for the seller.
item_id
integer
The unique identifier for the item.
charges
array of object (PriceAdjustmentCharge)
An array containing details of bags available for reorder.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
meta
object
An object containing additional metadata for the order.
currency
object (CurrencySchema)
Show
Represents the currency information for monetary values in the system according to ISO 4217.
currency_code
string
The ISO 4217 currency code, such as 'INR' for Indian Rupee. This field represents the standardized three-letter code of a currency.
currency_symbol
string
The symbol representing the currency, such as '₹' for Indian Rupee. This is used for display purposes alongside currency amounts.
Examples
Parameters
Parameters are not required.
Response
Get an order
getOrderById
Retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID.
Parameters
order_idpath
string
Required
A unique number used for identifying and tracking your orders.
GET
Response
200
Success.
Hide
Schema for Order Details.
order
object (OrderSchema)
Show
Schema for Order Details.
total_shipments_in_order
integer
The total number of shipments in the order.
gstin_code
string
A GST Number (Goods and Services Tax Identification Number, often abbreviated as GSTIN) is a unique identifier assigned to a business or individual registered under the Goods and Services Tax (GST) system in countries like India. The GST number is essential for businesses to comply with tax regulations and for the government to track tax payments and returns.
user_info
object (UserInfo)
Show
User Info.
first_name
string
First name of the user.
gender
string
Gender of the user.
name
string
Full name of the user (including first and last names).
last_name
string
Last name of the user.
mobile
string
Mobile number of the user.
email
string
Email address of the user.
breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (BreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
order_created_time
string
The date and time when the order was created.
order_created_ts
string
The timestamp when the order was created.
order_id
string
The unique identifier for the order.
shipments
array of object (Shipments)
An array containing details of individual shipments within the order.
Show
Shipment details Schema.
payment
object (ShipmentPayment)
Show
An object containing payment details.
mop
string
Abbreviation or code for the payment mode.
payment_mode
string
The specific payment mode used.
status
string
The current status of the payment.
mode
string
The payment mode.
logo
string
URL of the logo representing the payment mode.
display_name
string
The name to be displayed for the payment mode.
payment_info
array of object (ShipmentPaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Show
Array of objects containing shipment payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
mop
string
Stands for "Mode of Payment". This is a short code (like "COD" for Cash On Delivery) that represents the payment method used.
payment_mode
string
Information about the payment mode, indicates whether COD or PREPAID.
status
string
Indicates the current status of the payment, Paid or Unpaid.
mode
string
Information about the payment source. For eg, NB_ICICI.
logo
string
A URL to an image representing the payment method.
display_name
string
The name of the payment method as it should be displayed to the user.
amount
number
Amount paid using this payment method.
order_type
string
Nullable
Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example:
- "HomeDelivery": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address.
- "PickAtStore": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person.
- "Digital": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically.
Enum
gstin_code
string
A GST Number (Goods and Services Tax Identification Number, often abbreviated as GSTIN) is a unique identifier assigned to a business or individual registered under the Goods and Services Tax (GST) system in countries like India. The GST number is essential for businesses to comply with tax regulations and for the government to track tax payments and returns.
show_download_invoice
boolean
Indicates if the download invoice option should be shown.
can_cancel
boolean
Indicates if the shipment can be canceled.
user_info
object (ShipmentUserInfo)
Show
Schema for shipments user info.
first_name
string
The unique identifier of the store.
gender
string
A code associated with the store.
name
string
The name of the store.
last_name
string
The name of the company associated with the store.
mobile
string
The identifier of the company associated with the store.
email
string
Email address of the user.
shipment_id
string
The unique identifier for the shipment.
affiliate_shipment_id
string
External shipment ID provided by the sales channel or the extension.
fulfilling_store
object (FulfillingStore)
Show
Schema for fulfilling store.
id
integer
The unique identifier of the store.
code
string
A code associated with the store.
name
string
The name of the store.
company_name
string
The name of the company associated with the store.
company_id
integer
The identifier of the company associated with the store.
custom_meta
array of object
An object containing custom metadata for the shipment.
shipment_status
object (ShipmentStatus)
Show
Schema for shipment status.
value
string
Nullable
The internal or code value representing the shipment status.
title
string
The title or display name representing the shipment status.
hex_code
string
The hexadecimal color code associated with the shipment status. Each state of a shipment (like "processing", "cancelled", "delivered", etc.) is associated with a unique color, represented by a hex code. This color coding makes it visually intuitive for users to understand the status of their shipment at a glance.
comment
string
Any comments related to the shipment.
invoice
object (Invoice)
Show
Schema for invoice.
invoice_url
string
URL providing access to the invoice.
updated_date
string
| date-time
The date and time when the invoice was last updated.
label_url
string
URL providing access to the invoice label.
credit_note
object (CreditNote)
Show
It contains credit note related data pointers like credit note id, credit note pdf url, etc.
credit_note_id
string
Nullable
The identifier for any credit note issued for the shipment.
credit_note_url
string
Nullable
Pre-signed URL to download the credit note PDF document generated for the shipment.
show_track_link
boolean
Indicates if the track link should be shown.
refund_details
object
An object containing details of any refunds.
breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (BreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
can_break
object
Indicates whether a shipment can be split or broken down at specific stages of the shipment lifecycle. Specifies whether breaking the shipment is allowed.
traking_no
string
The tracking number for the shipment.
tracking_details
array of object (TrackingDetails)
An array containing details of the tracking history of the shipment.
Show
Schema for tracking details.
value
string
Nullable
Current value or state of the process.
is_current
boolean
Indicates whether the tracking event is the current or active status.
is_passed
boolean
Indicates whether the tracking event has passed or occurred.
status
string
The status of the tracking event.
time
string
The time associated with the tracking event.
created_ts
string
Timestamp when this status was created.
tracking_details
array of object (NestedTrackingDetails)
Nested tracking details.
Show
Schema for nested tracking details.
is_passed
boolean
Indicates whether the tracking event has passed or occurred.
time
string
The time associated with the tracking event.
is_current
boolean
Indicates whether the tracking event is the current or active status.
status
string
The status of the tracking event.
promise
object (Promise)
Show
Schema for promise.
show_promise
boolean
Indicates whether the promise details should be shown.
timestamp
object (TimeStampData)
Show
Schema for time stamp data.
min
string
The minimum timestamp value.
max
string
The maximum timestamp value.
total_bags
integer
The total number of bags in the shipment.
total_details
object (ShipmentTotalDetails)
Show
Schema for shipment total details.
pieces
integer
The total number of pieces included.
total_price
number
The total price of the order or item.
sizes
integer
The number of different sizes included.
prices
object (Prices)
Show
Schema for prices.
delivery_charge
number
The delivery charge for the order.
coupon_value
number
The value of the coupon applied.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
currency_symbol
string
The symbol of the currency used.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
promotion_effective_discount
number
The effective discount from promotions.
refund_amount
number
The amount refunded to the customer.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
returnable_date
string
| date-time
Nullable
The last date by which the item can be returned.
shipment_created_at
string
| date-time
The date and time when the shipment was created.
shipment_created_ts
string
The timestamp when the shipment was created.
size_info
object
An object containing size information for the items in the shipment.
bags
array of object (Bags)
An array containing details about the individual bags in the shipment.
Show
Bag details.
delivery_date
string
| date-time
Nullable
The date and time when the item is expected to be delivered.
line_number
integer
The line number of the item in the order.
currency_symbol
string
The symbol of the currency used.
item
object (Item)
Show
Schema for item.
image
array of string
An array of URLs pointing to images of the item.
l1_categories
array of string
An array of level 1 categories to which the item belongs.
l2_category
array of string
An array of level 2 categories to which the item belongs.
l2_category_id
number
ID representing the level 2 category classification of the item
brand
object (ItemBrand)
Show
Schema for brand within item.
logo
string
The URL of the brand's logo.
name
string
The name of the brand.
seller_identifier
string
The identifier for the seller.
code
string
The code or SKU of the item.
id
number
The unique identifier of the item.
name
string
The name of the item.
l3_category_name
string
This key specifies the name of the third-level category under which the product is listed, offering a more detailed classification within the e-commerce platform's hierarchy.
slug_key
string
A unique key or identifier for the item slug.
l2_categories
array of string
An array of level 2 categories the item belongs to.
size
string
The size of the item.
attributes
object
An object containing various attributes of the item.
applied_promos
array of object (AppliedPromos)
An array containing information about applied promotions.
Show
Schema for applied promos.
mrp_promotion
boolean
Indicates if the promotion is applied to the MRP.
promotion_name
string
The name of the promotion.
article_quantity
number
The quantity of articles required to qualify for the promotion.
promo_id
string
The unique identifier for the promotion.
amount
number
The discount amount provided by the promotion.
promotion_type
string
Specifies the type of discount or deal applied to the current promotion, defining how the promotion modifies the price or adds value to the purchase. Each type represents a different promotional strategy - percentage- Discount by a percentage of the original price. - amount- Discount by a specific amount off the original price. - fixed_price- Sets the price to a specific fixed amount. - bogo- Buy One Get One or at a discount. - contract_price- Special pricing based on a contract or agreement. - shipping_price- Discount or deal related to the shipping cost. - ladder_price- Price changes based on quantity purchased. - bundle_price_percentage- Discount on a bundle purchase by a percentage. - bundle_price_amount- Discount on a bundle purchase by a specific amount. - bundle_amount_percentage- A percentage of the purchase amount is applied as a discount when buying in a bundle. - custom- A custom promotion not covered by other types. - free_gift_items- Free gift items are included with the purchase. - free_non_sellable_items- Free items that are not for sale are included with the purchase. - item_based_discount- Specific percentage discounts on selected items based on their position after sorting by price in descending order.
Enum
applied_free_articles
array of object (AppliedFreeArticles)
An array containing details of free articles applied under the promotion.
Show
Schema for applied free articles.
article_id
string
The unique identifier for the article.
free_gift_item_details
object
An object containing details about the free gift item.
parent_item_identifier
string
The identifier for the parent item to which this free article is related.
quantity
number
The quantity of the free article.
quantity
integer
The quantity of the item.
prices
object (Prices)
Show
Schema for prices.
delivery_charge
number
The delivery charge for the order.
coupon_value
number
The value of the coupon applied.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
currency_symbol
string
The symbol of the currency used.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
promotion_effective_discount
number
The effective discount from promotions.
refund_amount
number
The amount refunded to the customer.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
can_cancel
boolean
Indicates if the item can be canceled.
can_return
boolean
Indicates if the item can be returned.
id
integer
The unique identifier for the order item.
returnable_date
string
| date-time
Nullable
The last date and time by which the item can be returned.
financial_breakup
array of object (FinancialBreakup)
An array containing financial details of the item.
Show
Financial breakup object.
coupon_value
number
The value of the coupon applied.
delivery_charge
number
The delivery charge for the order.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods. It is used in trade and commerce to identify products and services uniformly across different countries and industries. The system was developed by the World Customs Organization (WCO) and is widely used in customs processes and tax systems.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
size
string
The size of the item.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
total_units
integer
The total number of units purchased.
identifiers
object (Identifiers)
Show
An object containing identification details for the item.
ean
string
The European Article Number (EAN) of the item.
sku_code
string
The Stock Keeping Unit (SKU) code of the item - uniquely identifies each distinct product. SKUs are used to track inventory levels, facilitate accurate stocktaking, and streamline order fulfillment processes. This code is essential for inventory management, allowing for the differentiation between products based on attributes such as price, color, and size.
gst_tag
string
The GST tag indicating the type of GST applied.
item_name
string
The name of the item.
promotion_effective_discount
number
The effective discount from promotions.
gst_fee
number
The GST fee applied to the item.
refund_amount
number
The amount refunded to the customer.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Schema for Tax Component.
name
string
Name of tax component.
rate
number
Applied tax rate.
tax_amount
number
Tax Amount.
taxable_amount
number
Taxable Amount (Amount Without Tax).
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
parent_promo_bags
object
An object containing details of parent promotional bags.
meta
object
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
seller_identifier
string
The identifier for the seller.
current_status
object (CurrentStatus)
Show
Current status details.
updated_at
string
| date-time
The date and time when the status was last updated.
name
string
The name or label indicating the current state or status.
status
string
The current status of the bag.
journey_type
string
Nullable
It is a type being used to represent the journey of shipment through the performed status transition. Forward Journey: The forward journey encompasses all the stages of shipping, including order placement, packing, dispatch, in-transit updates, and delivery. Return Journey: Contrary to the forward journey, the return journey involves the process of sending items back from the customer to the original sender or a designated return facility.
Enum
article
object (Article)
Nullable
Show
Schema for article.
tags
array of string
An array of tags associated with the article.
charges
array of object (PriceAdjustmentCharge)
An array of charges associated with the order item.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
is_bundle_item
boolean
Flag to indicate whether the bag is part of a bundle.
bundle_details
object (BundleDetails)
Show
Contains bundle-related metadata for the shipment.
bundle_group_id
string
Unique group identifier for the bundle.
name
string
Name of the bundle.
slug
string
URL-friendly identifier for the bundle.
bundle_count
integer
Indicates bundle count of the bag.
article_bundle_id
string
Unique identifier for the article bundle.
bundle_article_quantity
integer
Article net_quantity in bundle Product.
is_base
boolean
Indicates if the item is a base item.
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 (BundleReturnConfig)
Show
Refund Config for bundle product
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
Seller Identifier of the bundle.
images
array of string
An array of image URLs associated with the bundle.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
dp_name
string
The name of the delivery partner.
awb_no
string
The airway bill number for the shipment.
beneficiary_details
boolean
Indicates if there are any beneficiary details.
fulfilling_company
object (FulfillingCompany)
Show
Fulfilling company details.
id
integer
The unique identifier for the fulfilling company.
name
string
The name of the fulfilling company.
can_return
boolean
Indicates if the shipment can be returned.
delivery_address
object (Address)
Show
An object containing the address details.
pincode
string
The postal code of the address.
phone
string
The phone number of the person associated with the address.
latitude
number
Nullable
The latitude coordinate.
address2
string
The secondary line of the address.
landmark
string
A nearby landmark.
area
string
The area or locality.
city
string
The city of the address.
address
string
The full address.
address_type
string
The type of the address (e.g., home, office).
Enum
longitude
number
Nullable
The longitude coordinate.
country_iso_code
string
The ISO code for the country.
state
string
The state of the address.
created_at
string
| date-time
The date and time when the address was created.
address1
string
The primary line of the address.
display_address
string
The formatted display address, typically used for printing or displaying in user interfaces.
name
string
The name of the person associated with the address.
contact_person
string
The name of the contact person.
address_category
string
Category or classification of the address. The address_category field
that includes "store", "delivery", and "billing" serves to classify
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy.
Enum
email
string
The email address.
country_phone_code
string
The country phone code.
version
string
The version of the address format.
updated_at
string
| date-time
The date and time when the address was last updated.
country
string
The country of the address.
billing_address
object (Address)
Show
An object containing the address details.
pincode
string
The postal code of the address.
phone
string
The phone number of the person associated with the address.
latitude
number
Nullable
The latitude coordinate.
address2
string
The secondary line of the address.
landmark
string
A nearby landmark.
area
string
The area or locality.
city
string
The city of the address.
address
string
The full address.
address_type
string
The type of the address (e.g., home, office).
Enum
longitude
number
Nullable
The longitude coordinate.
country_iso_code
string
The ISO code for the country.
state
string
The state of the address.
created_at
string
| date-time
The date and time when the address was created.
address1
string
The primary line of the address.
display_address
string
The formatted display address, typically used for printing or displaying in user interfaces.
name
string
The name of the person associated with the address.
contact_person
string
The name of the contact person.
address_category
string
Category or classification of the address. The address_category field
that includes "store", "delivery", and "billing" serves to classify
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy.
Enum
email
string
The email address.
country_phone_code
string
The country phone code.
version
string
The version of the address format.
updated_at
string
| date-time
The date and time when the address was last updated.
country
string
The country of the address.
track_url
string
The URL for tracking the shipment.
order_id
string
The unique identifier for the order.
need_help_url
string
The URL for customer support or help.
return_meta
object
An object containing metadata about the return process.
delivery_date
string
| date-time
Nullable
The expected delivery date.
order
object (OrderRequestSchema)
Show
An object containing meta-information about the order.
meta
object
Metadata for the order.
charges
array of object (PriceAdjustmentCharge)
An array of charge objects associated with the shipment.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
fulfillment_option
object (FulfillmentOption)
Show
Delivery service option with type, name, and default status.
slug
string
Unique identifier for the delivery type.
is_default
boolean
Indicates if this is the default delivery option.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
ndr_details
object (NdrDetailsSchema)
Show
Schema containig NDR related data pointers.
show_ndr_form
boolean
A boolean flag represent whether NDR form needs to be displayed or not.
non_editable_address_fields
array of string
A list of address fields that are not allowed to be updated while filling NDR form.
delivery_scheduled_date
string
| date-time
The scheduled date and time when the delivery reattempt is expected to take place. This value is selected by the customer during the NDR (Non-Delivery Report) flow, and is intended to guide the courier partner on when to attempt redelivery.
allowed_delivery_window
object (NdrDeliveryWindowSchema)
Show
Schema for NDR delivery window.
start_date
string
| date-time
The start date from which a customer can select to reattempt the delivery of a shipment.
end_date
string
| date-time
The end date till which a customer can is allowed to reattempt the delivery of a shipment.
excluded_dates
array of string
A list of dates which needs to be excluded from the range provided by start_date and end_date.
failure_reason
string
The reason recorded by the courier or delivery partner for the failed delivery attempt. This is typically selected or entered at the time of delivery when the attempt was unsuccessful. For example, "Customer not available", "Address not found", or "Premises closed".
delivery_partner_remarks
string
Any extra notes or observations added by the delivery partner at the time of a failed delivery attempt.
customer_remarks
string
Additional comments provided by the customer while rescheduling the delivery.
refund_modes
array of object (RefundModeData)
List of refund modes applicable to the shipment.
Show
Refund Mode applied to the shipment.
identifier
string
Unique identifier for the refund mode instance
amount_paid
number
Amount that was originally paid
refund_amount
number
Amount to be refunded
refund_status
object (RefundStatus)
Show
Refund Status
id
string
Unique identifier for the refund status.
status
string
Descriptive status of the refund (e.g., refund_acknowledged, refund_approved).
operational_status
string
Display Status for the storefront its pending when refund is in progress and completed when refund completed for a mode
transaction_info
array of object (RefundTransactionInfo)
Refund Status Transaction Info for the payment mode
Show
Represents transaction-level identifiers associated with a refund of a payment mode/Methods.
rrn
string
Refund Reference Number (RRN) generated for the refund transaction.
utr
string
Unique Transaction Reference (UTR) for the refund.
mode
string
Payment mode for which the refund was processed. Please refer for detailed Payment Mode.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_ts
string
Timestamp when the refund status was created.
updated_ts
string
Timestamp when the refund status was last updated.
updated_by
string
Identifier for the user or process that last updated the refund status.
remarks
string
Additional remarks or notes
beneficiary_details
object (BeneficiaryDetails)
Show
Details of the bank beneficiary to whom the refund will be made.
account_holder
string
Name of the account holder
account_no
string
Bank account number (may be masked)
bank_name
string
Name of the bank
beneficiary_id
string
Encrypted/encoded beneficiary identifier
branch_name
string
Bank branch name
is_verified
boolean
Whether the beneficiary details are verified
vpa_address
string
VPA Address of the customer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
meta
object
Additional metadata
refund_mode
string
Method of refund processing
logo
string
Refund Mode logo.
display_name
string
Human-readable name for the refund mode
payment_identifiers
array of string
Additional payment information
operational_status
string
Display Status for the storefront its pending when refund is in progress and completed when refund completed for a mode
transaction_data
object
Refund Status Transaction Data
default_refund_mode
boolean
Indicates that the system assigned a default refund mode when no refund mode is chosen during the return/refund process.
refund_breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (BreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
is_refund_config_enabled
boolean
Indicates whether refund configuration is enabled for the sales channel; if disabled, no refund options are shown, and if enabled, the applicable refund modes are displayed.
meta
object
Client-defined shipment-level metadata. The structure is flexible and interpretation is the client’s responsibility.
bags_for_reorder
array of object (BagsForReorder)
Items to be added to the cart when reordering a previous purchase.
Show
An array containing details of bags available for reorder.
item_size
string
The size of the item.
quantity
integer
The quantity of the item.
store_id
integer
The identifier for the store.
article_assignment
object (BagsForReorderArticleAssignment)
Show
An object containing details about the assignment of articles.
strategy
string
The strategy used for article assignment.
level
string
The level at which the article assignment is made.
seller_id
integer
The identifier for the seller.
item_id
integer
The unique identifier for the item.
charges
array of object (PriceAdjustmentCharge)
An array containing details of bags available for reorder.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
meta
object
An object containing additional metadata for the order.
currency
object (CurrencySchema)
Show
Represents the currency information for monetary values in the system according to ISO 4217.
currency_code
string
The ISO 4217 currency code, such as 'INR' for Indian Rupee. This field represents the standardized three-letter code of a currency.
currency_symbol
string
The symbol representing the currency, such as '₹' for Indian Rupee. This is used for display purposes alongside currency amounts.
Examples
Parameters
Parameters are not required.
Response
Retrieves POS order details
getPosOrderById
Operations
GET
# Get refund modes for a shipment
POST
# Get refund modes and Refund Price Break for a shipment
Returns a list of available refund options for the given company and shipment.
Parameters
shipment_idpath
string
Required
Numeric identifier of the shipment.
line_numbersquery
array of integer
A comma-separated list of line numbers.
GET
Response
200
A JSON object containing refund options.
Hide
Collection of available refund options for a transaction
refund_options
array of object (RefundOption)
List of all available refund options for the user to choose from
Show
Represents a complete refund option available to the user
slug
string
Unique identifier for the refund option
display_name
string
User-friendly name for the refund option shown in the UI
amount
number
| float
The refund amount value to be processed
currency_symbol
string
Symbol representing the currency of the refund amount
message
string
Additional information or instructions related to this refund option
logo
string
| uri
URI reference to the logo image for this refund option
beneficiary_type
string
Indicates the type of account receiving the refund
suggested_list
array of string
Suggestion List for the Refund Mode Option e.g (@sbiupi, @paytm)
refund_modes
array of object (RefundMode)
List of available refund modes for this refund option
Show
Represents a mode or method through which a refund can be processed
refund_mode
string
Unique identifier for the refund mode
display_name
string
User-friendly name for the refund mode shown in the UI
payment_identifiers
array of string
List of specific transfer mechanisms available within this refund mode
refund_price_breakup
array of object (PriceBreakupValues)
Refund Prices Breakup values of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (PriceBreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
is_refund_config_enabled
boolean
Indicates whether refund configuration is enabled for the sales channel; if disabled, no refund options are shown, and if enabled, the applicable refund modes are displayed.
Examples
Parameters
shipment_id:
"value"
line_numbers:
0,1
Response
Get refund modes for a shipment
getRefundModes
Returns a list of available refund options for the given company and shipment.
Parameters
shipment_idpath
string
Required
Numeric identifier of the shipment.
bodyrequestBody
object (RefundModeRequestData)
Required
Hide
Request payload containing shipment bag line number level details used to determine the applicable refund mode and refund breakup.
line_numbers
array of object (RefundModeLineNumber)
List of shipment bag line numbers and their respective quantities for which the refund is being requested.
Show
Represents a specific line number in a bag along with the quantity eligible for refund.
line_number
number
Unique identifier of the shipment bag line number for which the refund is being requested.
quantity
number
Number of units from the specified line number to be returned and refunded.
next_state
string
Optional shipment state to preview the refund against (e.g. cancelled_customer, return_initiated). The refund_amount is calculated based on this state.
Request body
line_numbers
array of object (RefundModeLineNumber)
List of shipment bag line numbers and their respective quantities for which the refund is being requested.
Show
Represents a specific line number in a bag along with the quantity eligible for refund.
line_number
number
Unique identifier of the shipment bag line number for which the refund is being requested.
quantity
number
Number of units from the specified line number to be returned and refunded.
next_state
string
Optional shipment state to preview the refund against (e.g. cancelled_customer, return_initiated). The refund_amount is calculated based on this state.
POST
Response
200
A JSON object containing refund options.
Hide
Collection of available refund options for a transaction
refund_options
array of object (RefundOption)
List of all available refund options for the user to choose from
Show
Represents a complete refund option available to the user
slug
string
Unique identifier for the refund option
display_name
string
User-friendly name for the refund option shown in the UI
amount
number
| float
The refund amount value to be processed
currency_symbol
string
Symbol representing the currency of the refund amount
message
string
Additional information or instructions related to this refund option
logo
string
| uri
URI reference to the logo image for this refund option
beneficiary_type
string
Indicates the type of account receiving the refund
suggested_list
array of string
Suggestion List for the Refund Mode Option e.g (@sbiupi, @paytm)
refund_modes
array of object (RefundMode)
List of available refund modes for this refund option
Show
Represents a mode or method through which a refund can be processed
refund_mode
string
Unique identifier for the refund mode
display_name
string
User-friendly name for the refund mode shown in the UI
payment_identifiers
array of string
List of specific transfer mechanisms available within this refund mode
refund_price_breakup
array of object (PriceBreakupValues)
Refund Prices Breakup values of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (PriceBreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
is_refund_config_enabled
boolean
Indicates whether refund configuration is enabled for the sales channel; if disabled, no refund options are shown, and if enabled, the applicable refund modes are displayed.
Examples
Parameters
shipment_id:
"value"
body:
body
Response
Get refund modes and Refund Price Break for a shipment
getRefundModesWithPriceBreakup
Shipment represents the physical movement of goods from the seller (or your warehouse) to the customer. It's associated with a specific order and includes details like tracking information, carrier used, weight, dimensions, and estimated delivery date. An Order can contain multiple shipments. Shipments are created based on multiple factors like selling location assigned to that shipment, the packaging material available etc. A shipment will get created whenever there is a partial transition of items also when there is a negative state transition is invoked. Negative state transition can be defined against a state. Currently only some defined states are configured as negative. If any state is to be added as negative state then please contact support team.
Operations
GET
# Get a Shipment
GET
# Retrieves invoice for shipment
GET
# Track shipment status
GET
# Get shipment's customer
POST
# Send OTP to customer
POST
# Verifies OTP
GET
# List shipment cancellation reasons
PUT
# Updates shipment status
PUT
# Initiates a delivery reattempt request for a given shipment
Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID.
Parameters
shipment_idpath
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
allow_inactivequery
boolean
Flag to allow inactive shipments.
Default Value : false
GET
Response
200
Success.
Hide
Data of shipment.
shipment
object (Shipments)
Show
Shipment details Schema.
payment
object (ShipmentPayment)
Show
An object containing payment details.
mop
string
Abbreviation or code for the payment mode.
payment_mode
string
The specific payment mode used.
status
string
The current status of the payment.
mode
string
The payment mode.
logo
string
URL of the logo representing the payment mode.
display_name
string
The name to be displayed for the payment mode.
payment_info
array of object (ShipmentPaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Show
Array of objects containing shipment payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
mop
string
Stands for "Mode of Payment". This is a short code (like "COD" for Cash On Delivery) that represents the payment method used.
payment_mode
string
Information about the payment mode, indicates whether COD or PREPAID.
status
string
Indicates the current status of the payment, Paid or Unpaid.
mode
string
Information about the payment source. For eg, NB_ICICI.
logo
string
A URL to an image representing the payment method.
display_name
string
The name of the payment method as it should be displayed to the user.
amount
number
Amount paid using this payment method.
order_type
string
Nullable
Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example:
- "HomeDelivery": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address.
- "PickAtStore": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person.
- "Digital": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically.
Enum
gstin_code
string
A GST Number (Goods and Services Tax Identification Number, often abbreviated as GSTIN) is a unique identifier assigned to a business or individual registered under the Goods and Services Tax (GST) system in countries like India. The GST number is essential for businesses to comply with tax regulations and for the government to track tax payments and returns.
show_download_invoice
boolean
Indicates if the download invoice option should be shown.
can_cancel
boolean
Indicates if the shipment can be canceled.
user_info
object (ShipmentUserInfo)
Show
Schema for shipments user info.
first_name
string
The unique identifier of the store.
gender
string
A code associated with the store.
name
string
The name of the store.
last_name
string
The name of the company associated with the store.
mobile
string
The identifier of the company associated with the store.
email
string
Email address of the user.
shipment_id
string
The unique identifier for the shipment.
affiliate_shipment_id
string
External shipment ID provided by the sales channel or the extension.
fulfilling_store
object (FulfillingStore)
Show
Schema for fulfilling store.
id
integer
The unique identifier of the store.
code
string
A code associated with the store.
name
string
The name of the store.
company_name
string
The name of the company associated with the store.
company_id
integer
The identifier of the company associated with the store.
custom_meta
array of object
An object containing custom metadata for the shipment.
shipment_status
object (ShipmentStatus)
Show
Schema for shipment status.
value
string
Nullable
The internal or code value representing the shipment status.
title
string
The title or display name representing the shipment status.
hex_code
string
The hexadecimal color code associated with the shipment status. Each state of a shipment (like "processing", "cancelled", "delivered", etc.) is associated with a unique color, represented by a hex code. This color coding makes it visually intuitive for users to understand the status of their shipment at a glance.
comment
string
Any comments related to the shipment.
invoice
object (Invoice)
Show
Schema for invoice.
invoice_url
string
URL providing access to the invoice.
updated_date
string
| date-time
The date and time when the invoice was last updated.
label_url
string
URL providing access to the invoice label.
credit_note
object (CreditNote)
Show
It contains credit note related data pointers like credit note id, credit note pdf url, etc.
credit_note_id
string
Nullable
The identifier for any credit note issued for the shipment.
credit_note_url
string
Nullable
Pre-signed URL to download the credit note PDF document generated for the shipment.
show_track_link
boolean
Indicates if the track link should be shown.
refund_details
object
An object containing details of any refunds.
breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (BreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
can_break
object
Indicates whether a shipment can be split or broken down at specific stages of the shipment lifecycle. Specifies whether breaking the shipment is allowed.
traking_no
string
The tracking number for the shipment.
tracking_details
array of object (TrackingDetails)
An array containing details of the tracking history of the shipment.
Show
Schema for tracking details.
value
string
Nullable
Current value or state of the process.
is_current
boolean
Indicates whether the tracking event is the current or active status.
is_passed
boolean
Indicates whether the tracking event has passed or occurred.
status
string
The status of the tracking event.
time
string
The time associated with the tracking event.
created_ts
string
Timestamp when this status was created.
tracking_details
array of object (NestedTrackingDetails)
Nested tracking details.
Show
Schema for nested tracking details.
is_passed
boolean
Indicates whether the tracking event has passed or occurred.
time
string
The time associated with the tracking event.
is_current
boolean
Indicates whether the tracking event is the current or active status.
status
string
The status of the tracking event.
promise
object (Promise)
Show
Schema for promise.
show_promise
boolean
Indicates whether the promise details should be shown.
timestamp
object (TimeStampData)
Show
Schema for time stamp data.
min
string
The minimum timestamp value.
max
string
The maximum timestamp value.
total_bags
integer
The total number of bags in the shipment.
total_details
object (ShipmentTotalDetails)
Show
Schema for shipment total details.
pieces
integer
The total number of pieces included.
total_price
number
The total price of the order or item.
sizes
integer
The number of different sizes included.
prices
object (Prices)
Show
Schema for prices.
delivery_charge
number
The delivery charge for the order.
coupon_value
number
The value of the coupon applied.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
currency_symbol
string
The symbol of the currency used.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
promotion_effective_discount
number
The effective discount from promotions.
refund_amount
number
The amount refunded to the customer.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
returnable_date
string
| date-time
Nullable
The last date by which the item can be returned.
shipment_created_at
string
| date-time
The date and time when the shipment was created.
shipment_created_ts
string
The timestamp when the shipment was created.
size_info
object
An object containing size information for the items in the shipment.
bags
array of object (Bags)
An array containing details about the individual bags in the shipment.
Show
Bag details.
delivery_date
string
| date-time
Nullable
The date and time when the item is expected to be delivered.
line_number
integer
The line number of the item in the order.
currency_symbol
string
The symbol of the currency used.
item
object (Item)
Show
Schema for item.
image
array of string
An array of URLs pointing to images of the item.
l1_categories
array of string
An array of level 1 categories to which the item belongs.
l2_category
array of string
An array of level 2 categories to which the item belongs.
l2_category_id
number
ID representing the level 2 category classification of the item
brand
object (ItemBrand)
Show
Schema for brand within item.
logo
string
The URL of the brand's logo.
name
string
The name of the brand.
seller_identifier
string
The identifier for the seller.
code
string
The code or SKU of the item.
id
number
The unique identifier of the item.
name
string
The name of the item.
l3_category_name
string
This key specifies the name of the third-level category under which the product is listed, offering a more detailed classification within the e-commerce platform's hierarchy.
slug_key
string
A unique key or identifier for the item slug.
l2_categories
array of string
An array of level 2 categories the item belongs to.
size
string
The size of the item.
attributes
object
An object containing various attributes of the item.
applied_promos
array of object (AppliedPromos)
An array containing information about applied promotions.
Show
Schema for applied promos.
mrp_promotion
boolean
Indicates if the promotion is applied to the MRP.
promotion_name
string
The name of the promotion.
article_quantity
number
The quantity of articles required to qualify for the promotion.
promo_id
string
The unique identifier for the promotion.
amount
number
The discount amount provided by the promotion.
promotion_type
string
Specifies the type of discount or deal applied to the current promotion, defining how the promotion modifies the price or adds value to the purchase. Each type represents a different promotional strategy - percentage- Discount by a percentage of the original price. - amount- Discount by a specific amount off the original price. - fixed_price- Sets the price to a specific fixed amount. - bogo- Buy One Get One or at a discount. - contract_price- Special pricing based on a contract or agreement. - shipping_price- Discount or deal related to the shipping cost. - ladder_price- Price changes based on quantity purchased. - bundle_price_percentage- Discount on a bundle purchase by a percentage. - bundle_price_amount- Discount on a bundle purchase by a specific amount. - bundle_amount_percentage- A percentage of the purchase amount is applied as a discount when buying in a bundle. - custom- A custom promotion not covered by other types. - free_gift_items- Free gift items are included with the purchase. - free_non_sellable_items- Free items that are not for sale are included with the purchase. - item_based_discount- Specific percentage discounts on selected items based on their position after sorting by price in descending order.
Enum
applied_free_articles
array of object (AppliedFreeArticles)
An array containing details of free articles applied under the promotion.
Show
Schema for applied free articles.
article_id
string
The unique identifier for the article.
free_gift_item_details
object
An object containing details about the free gift item.
parent_item_identifier
string
The identifier for the parent item to which this free article is related.
quantity
number
The quantity of the free article.
quantity
integer
The quantity of the item.
prices
object (Prices)
Show
Schema for prices.
delivery_charge
number
The delivery charge for the order.
coupon_value
number
The value of the coupon applied.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
currency_symbol
string
The symbol of the currency used.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
promotion_effective_discount
number
The effective discount from promotions.
refund_amount
number
The amount refunded to the customer.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
can_cancel
boolean
Indicates if the item can be canceled.
can_return
boolean
Indicates if the item can be returned.
id
integer
The unique identifier for the order item.
returnable_date
string
| date-time
Nullable
The last date and time by which the item can be returned.
financial_breakup
array of object (FinancialBreakup)
An array containing financial details of the item.
Show
Financial breakup object.
coupon_value
number
The value of the coupon applied.
delivery_charge
number
The delivery charge for the order.
brand_calculated_amount
number
The amount calculated by the brand.
value_of_good
number
The value of the goods before tax and other charges.
price_marked
number
The original marked price of the item.
coupon_effective_discount
number
The effective discount from coupons.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods. It is used in trade and commerce to identify products and services uniformly across different countries and industries. The system was developed by the World Customs Organization (WCO) and is widely used in customs processes and tax systems.
discount
number
The discount applied to the item.
gst_tax_percentage
number
The GST tax percentage applied.
cod_charges
number
The cash on delivery charges, if applicable.
amount_paid
number
The total amount paid by the customer.
added_to_fynd_cash
boolean
Indicates if the refund amount was added to Fynd Cash.
size
string
The size of the item.
transfer_price
number
The transfer price of the item.
cashback_applied
number
The amount of cashback applied.
price_effective
number
The effective price after all adjustments.
cashback
number
The cashback amount earned.
refund_credit
number
The amount credited for refund.
amount_paid_roundoff
number
The rounded-off amount paid by the customer.
total_units
integer
The total number of units purchased.
identifiers
object (Identifiers)
Show
An object containing identification details for the item.
ean
string
The European Article Number (EAN) of the item.
sku_code
string
The Stock Keeping Unit (SKU) code of the item - uniquely identifies each distinct product. SKUs are used to track inventory levels, facilitate accurate stocktaking, and streamline order fulfillment processes. This code is essential for inventory management, allowing for the differentiation between products based on attributes such as price, color, and size.
gst_tag
string
The GST tag indicating the type of GST applied.
item_name
string
The name of the item.
promotion_effective_discount
number
The effective discount from promotions.
gst_fee
number
The GST fee applied to the item.
refund_amount
number
The amount refunded to the customer.
fynd_credits
number
The amount of Fynd credits used.
amount_to_be_collected
number
The total amount that needs to be collected from the customer.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Schema for Tax Component.
name
string
Name of tax component.
rate
number
Applied tax rate.
tax_amount
number
Tax Amount.
taxable_amount
number
Taxable Amount (Amount Without Tax).
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
parent_promo_bags
object
An object containing details of parent promotional bags.
meta
object
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
currency_code
string
This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
seller_identifier
string
The identifier for the seller.
current_status
object (CurrentStatus)
Show
Current status details.
updated_at
string
| date-time
The date and time when the status was last updated.
name
string
The name or label indicating the current state or status.
status
string
The current status of the bag.
journey_type
string
Nullable
It is a type being used to represent the journey of shipment through the performed status transition. Forward Journey: The forward journey encompasses all the stages of shipping, including order placement, packing, dispatch, in-transit updates, and delivery. Return Journey: Contrary to the forward journey, the return journey involves the process of sending items back from the customer to the original sender or a designated return facility.
Enum
article
object (Article)
Nullable
Show
Schema for article.
tags
array of string
An array of tags associated with the article.
charges
array of object (PriceAdjustmentCharge)
An array of charges associated with the order item.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
is_bundle_item
boolean
Flag to indicate whether the bag is part of a bundle.
bundle_details
object (BundleDetails)
Show
Contains bundle-related metadata for the shipment.
bundle_group_id
string
Unique group identifier for the bundle.
name
string
Name of the bundle.
slug
string
URL-friendly identifier for the bundle.
bundle_count
integer
Indicates bundle count of the bag.
article_bundle_id
string
Unique identifier for the article bundle.
bundle_article_quantity
integer
Article net_quantity in bundle Product.
is_base
boolean
Indicates if the item is a base item.
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 (BundleReturnConfig)
Show
Refund Config for bundle product
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
Seller Identifier of the bundle.
images
array of string
An array of image URLs associated with the bundle.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
dp_name
string
The name of the delivery partner.
awb_no
string
The airway bill number for the shipment.
beneficiary_details
boolean
Indicates if there are any beneficiary details.
fulfilling_company
object (FulfillingCompany)
Show
Fulfilling company details.
id
integer
The unique identifier for the fulfilling company.
name
string
The name of the fulfilling company.
can_return
boolean
Indicates if the shipment can be returned.
delivery_address
object (Address)
Show
An object containing the address details.
pincode
string
The postal code of the address.
phone
string
The phone number of the person associated with the address.
latitude
number
Nullable
The latitude coordinate.
address2
string
The secondary line of the address.
landmark
string
A nearby landmark.
area
string
The area or locality.
city
string
The city of the address.
address
string
The full address.
address_type
string
The type of the address (e.g., home, office).
Enum
longitude
number
Nullable
The longitude coordinate.
country_iso_code
string
The ISO code for the country.
state
string
The state of the address.
created_at
string
| date-time
The date and time when the address was created.
address1
string
The primary line of the address.
display_address
string
The formatted display address, typically used for printing or displaying in user interfaces.
name
string
The name of the person associated with the address.
contact_person
string
The name of the contact person.
address_category
string
Category or classification of the address. The address_category field
that includes "store", "delivery", and "billing" serves to classify
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy.
Enum
email
string
The email address.
country_phone_code
string
The country phone code.
version
string
The version of the address format.
updated_at
string
| date-time
The date and time when the address was last updated.
country
string
The country of the address.
billing_address
object (Address)
Show
An object containing the address details.
pincode
string
The postal code of the address.
phone
string
The phone number of the person associated with the address.
latitude
number
Nullable
The latitude coordinate.
address2
string
The secondary line of the address.
landmark
string
A nearby landmark.
area
string
The area or locality.
city
string
The city of the address.
address
string
The full address.
address_type
string
The type of the address (e.g., home, office).
Enum
longitude
number
Nullable
The longitude coordinate.
country_iso_code
string
The ISO code for the country.
state
string
The state of the address.
created_at
string
| date-time
The date and time when the address was created.
address1
string
The primary line of the address.
display_address
string
The formatted display address, typically used for printing or displaying in user interfaces.
name
string
The name of the person associated with the address.
contact_person
string
The name of the contact person.
address_category
string
Category or classification of the address. The address_category field
that includes "store", "delivery", and "billing" serves to classify
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy.
Enum
email
string
The email address.
country_phone_code
string
The country phone code.
version
string
The version of the address format.
updated_at
string
| date-time
The date and time when the address was last updated.
country
string
The country of the address.
track_url
string
The URL for tracking the shipment.
order_id
string
The unique identifier for the order.
need_help_url
string
The URL for customer support or help.
return_meta
object
An object containing metadata about the return process.
delivery_date
string
| date-time
Nullable
The expected delivery date.
order
object (OrderRequestSchema)
Show
An object containing meta-information about the order.
meta
object
Metadata for the order.
charges
array of object (PriceAdjustmentCharge)
An array of charge objects associated with the shipment.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
fulfillment_option
object (FulfillmentOption)
Show
Delivery service option with type, name, and default status.
slug
string
Unique identifier for the delivery type.
is_default
boolean
Indicates if this is the default delivery option.
type
string
Type of fulfillment option.
Enum
name
string
Name of the delivery service.
ndr_details
object (NdrDetailsSchema)
Show
Schema containig NDR related data pointers.
show_ndr_form
boolean
A boolean flag represent whether NDR form needs to be displayed or not.
non_editable_address_fields
array of string
A list of address fields that are not allowed to be updated while filling NDR form.
delivery_scheduled_date
string
| date-time
The scheduled date and time when the delivery reattempt is expected to take place. This value is selected by the customer during the NDR (Non-Delivery Report) flow, and is intended to guide the courier partner on when to attempt redelivery.
allowed_delivery_window
object (NdrDeliveryWindowSchema)
Show
Schema for NDR delivery window.
start_date
string
| date-time
The start date from which a customer can select to reattempt the delivery of a shipment.
end_date
string
| date-time
The end date till which a customer can is allowed to reattempt the delivery of a shipment.
excluded_dates
array of string
A list of dates which needs to be excluded from the range provided by start_date and end_date.
failure_reason
string
The reason recorded by the courier or delivery partner for the failed delivery attempt. This is typically selected or entered at the time of delivery when the attempt was unsuccessful. For example, "Customer not available", "Address not found", or "Premises closed".
delivery_partner_remarks
string
Any extra notes or observations added by the delivery partner at the time of a failed delivery attempt.
customer_remarks
string
Additional comments provided by the customer while rescheduling the delivery.
refund_modes
array of object (RefundModeData)
List of refund modes applicable to the shipment.
Show
Refund Mode applied to the shipment.
identifier
string
Unique identifier for the refund mode instance
amount_paid
number
Amount that was originally paid
refund_amount
number
Amount to be refunded
refund_status
object (RefundStatus)
Show
Refund Status
id
string
Unique identifier for the refund status.
status
string
Descriptive status of the refund (e.g., refund_acknowledged, refund_approved).
operational_status
string
Display Status for the storefront its pending when refund is in progress and completed when refund completed for a mode
transaction_info
array of object (RefundTransactionInfo)
Refund Status Transaction Info for the payment mode
Show
Represents transaction-level identifiers associated with a refund of a payment mode/Methods.
rrn
string
Refund Reference Number (RRN) generated for the refund transaction.
utr
string
Unique Transaction Reference (UTR) for the refund.
mode
string
Payment mode for which the refund was processed. Please refer for detailed Payment Mode.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
created_ts
string
Timestamp when the refund status was created.
updated_ts
string
Timestamp when the refund status was last updated.
updated_by
string
Identifier for the user or process that last updated the refund status.
remarks
string
Additional remarks or notes
beneficiary_details
object (BeneficiaryDetails)
Show
Details of the bank beneficiary to whom the refund will be made.
account_holder
string
Name of the account holder
account_no
string
Bank account number (may be masked)
bank_name
string
Name of the bank
beneficiary_id
string
Encrypted/encoded beneficiary identifier
branch_name
string
Bank branch name
is_verified
boolean
Whether the beneficiary details are verified
vpa_address
string
VPA Address of the customer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
meta
object
Additional metadata
refund_mode
string
Method of refund processing
logo
string
Refund Mode logo.
display_name
string
Human-readable name for the refund mode
payment_identifiers
array of string
Additional payment information
operational_status
string
Display Status for the storefront its pending when refund is in progress and completed when refund completed for a mode
transaction_data
object
Refund Status Transaction Data
default_refund_mode
boolean
Indicates that the system assigned a default refund mode when no refund mode is chosen during the return/refund process.
refund_breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Show
Breakup details of various charges and discounts.
value
number
The numerical value associated with the entity.
currency_symbol
string
Symbol representing the currency used for the value.
name
string
The official name of the entity.
display
string
The name of the entity as it should be displayed.
currency_code
string
The international currency code representing the currency used for the value. This specifies the currency code for all amounts. The currency_code field will hold a string value representing the code for the currency in which all monetary amounts are denominated. This code typically follows the ISO 4217 standard, which uses three-letter alphabetic codes to define different currencies around the world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
sub_values
array of object (BreakupValues)
Array of nested breakup values that can contain further sub-values (recursive structure)
Show
Breakup details of various charges and discounts.
is_refund_config_enabled
boolean
Indicates whether refund configuration is enabled for the sales channel; if disabled, no refund options are shown, and if enabled, the applicable refund modes are displayed.
meta
object
Client-defined shipment-level metadata. The structure is flexible and interpretation is the client’s responsibility.
Examples
Parameters
Parameters are not required.
Response
Get a Shipment
getShipmentById
Parameters
shipment_idpath
string
Required
Unique identifier for a shipment.
GET
Response
200
Success.
Hide
Get invoice shipment response.
presigned_type
string
Type of presigned URL.
Enum
success
boolean
Indicates if the operation was successful.
shipment_id
string
Unique identifier for the shipment.
presigned_url
string
The presigned URL for accessing the shipment data, obtained from the response data.
Examples
Parameters
Parameters are not required.
Response
Retrieves invoice for shipment
getInvoiceByShipmentId
Parameters
shipment_idpath
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
Default Value : 16544950215681060915J
GET
Response
200
Success.
Hide
Shipment tracking details.
results
array of object (Track)
A array containing tracking details.
Show
Individual shipment track details.
account_name
string
The name of the account handling the shipment.
shipment_type
string
Journey Type of the Shipment.
Enum
status
string
The current status of the shipment.
last_location_recieved_at
string
The last known location of the shipment.
updated_time
string
The timestamp of the last update.
updated_at
string
| date-time
The date and time when the shipment was last updated.
reason
string
The reason or additional information about the shipment.
awb
string
The Air Waybill (AWB) number for the shipment.
meta
object
A field to store additional metadata related to the courier partner's operations or the shipment.
Examples
Parameters
Parameters are not required.
Response
Track shipment status
trackShipment
Parameters
order_idpath
string
Required
A unique number used for identifying and tracking your orders.
Default Value : 16544950215681060915J
shipment_idpath
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
Default Value : FY6299E19701B4EAEFC2
GET
Response
200
Success.
Hide
Schema for customer details response.
phone
string
Customer's phone number.
shipment_id
string
Unique identifier of the shipment.
name
string
Customer's name.
order_id
string
Unique identifier of the order.
country
string
Country of the customer.
Examples
Parameters
Parameters are not required.
Response
Get shipment's customer
getCustomerDetailsByShipmentId
Parameters
order_idpath
string
Required
A unique number used for identifying and tracking your orders.
Default Value : FY6299E19701B4EAEFC2
shipment_idpath
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
Default Value : 16544950215681060915J
event_typequery
string
Type of the event for which the OTP needs to be sent. This determines the context or purpose of OTP verification. Supported values are:
- `refund_bank_details`: Used when the customer needs to verify refund bank information.
- `customer_ndr`: Used when the customer needs to confirm delivery preferences after a failed delivery attempt (Non-Delivery Report).
Default Value : refund_bank_details
Enum
POST
Response
200
Success to acknowledge the service was notified
Hide
Schema for send otp.
request_id
string
Unique identifier for the request.
message
string
Message indicating the result of the request.
success
boolean
Indicates whether the request was successful.
resend_timer
integer
Time in seconds before the OTP can be resent.
Examples
Parameters
Parameters are not required.
Response
Send OTP to customer
sendOtpToShipmentCustomer
Parameters
order_idpath
string
Required
A string that represents the unique identifier assigned to the order.
Default Value : FYMP6294545C010B89FD
shipment_idpath
string
Required
The unique identifier for the shipment.
Default Value : 16538880933361957252J
bodyrequestBody
object (VerifyOtp)
Required
Hide
Schema for OTP verification.
otp_code
string
The OTP code provided by the user for verification.
request_id
string
Unique identifier for the request.
Request body
otp_code
string
The OTP code provided by the user for verification.
request_id
string
Unique identifier for the request.
POST
Response
200
Success, the code is valid and returns a session token
Hide
Schema for verifying otp response.
success
boolean
Indicates whether the request was successful.
message
string
Error message indicating if the verification data is expired or if the request is malformed, helping to diagnose and address issues with the verification process.
Examples
Parameters
Parameters are not required.
Response
Verifies OTP
verifyOtpShipmentCustomer
Get reasons to perform full or partial cancellation of a shipment.
Parameters
shipment_idpath
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
GET
Response
200
Success.
Hide
Schema for shipment reasons.
reasons
array of object (ShipmentReason)
A list of shipment reasons.
Show
Individual shipment reason details.
priority
integer
The priority level of the reason.
show_text_area
boolean
A flag indicating whether to show a textbox on the frontend.
reason_id
integer
The unique identifier for the reason.
feedback_type
string
The type of feedback.
Enum
reason_text
string
The text describing the reason.
flow
string
The process flow related to the reason.
Examples
Parameters
Parameters are not required.
Response
List shipment cancellation reasons
getShipmentReasons
This operation allows for updating the status and properties of a shipment. For example, it allows users to initiate a return by providing reasons and uploading quality check images.
Parameters
shipment_idpath
string
Required
The unique identifier for the shipment.
bodyrequestBody
object (UpdateShipmentStatusRequestSchema)
Required
Hide
Schema for update shipment status request.
statuses
array of object (StatuesRequestSchema)
An array detailing the various statuses that the requester wants to transition to, with each entry representing a distinct status. Each status object includes comprehensive details about the status, product specifics, reasons for the status (if applicable), and any updates to shipment or product data.
Show
Schema for statuses.
shipments
array of object (ShipmentsRequestSchema)
A list containing information about shipments.
Show
Shipment Info.
reasons
object (ReasonsData)
Show
Schema for reasons data.
products
array of object (ProductsReasons)
Reasons data for bags.
Show
Reasons data for bags.
data
object (ProductsReasonsData)
Show
Product reasons details.
reason_id
integer
The unique identifier for the reason.
reason_text
string
The text describing the reason.
filters
array of object (ProductsReasonsFilters)
Criteria applied to filter the products.
Show
Reasons data for bags filters.
line_number
integer
The specific line item of bag.
quantity
integer
The quantity of the product.
identifier
string
The unique identifier for the product.
entities
array of object (EntitiesReasons)
Reasons data for shipments.
Show
Schema for entity reasons.
data
object (EntityReasonData)
Show
Information about the reason.
reason_id
integer
The unique identifier for the reason.
reason_text
string
The text describing the reason.
filters
array of object
Criteria applied to filter the shipment.
products
array of object (Products)
Specific bag to be updated.
Show
Schema for products.
line_number
integer
The specific line item of bag.
quantity
integer
The quantity of the product.
identifier
string
The unique identifier for the product.
data_updates
object (DataUpdates)
Show
Data to be updated.
products
array of object (ProductsDataUpdates)
Data updates for bags.
Show
Schema for product data updates.
data
object
Information about the data to be updated.
filters
array of object (ProductsDataUpdatesFilters)
Criteria applied to filter the products.
Show
Schema for products filters.
line_number
integer
| int32
Represents the specific line item within a bag, used to identify and reference a particular product in a list. This helps in pinpointing the exact item being updated or processed.
identifier
string
A unique string that serves as the product’s identifier, such as a SKU, barcode, or another distinct code. This ensures the product is correctly identified and distinguished from other items in the system.
quantity
integer
| int32
The quantity of the product or item, specified as an integer. This indicates how many units of the product are being referenced or processed, such as the number of items in a bag or shipment.
entities
array of object (EntitiesDataUpdates)
Data updates for shipments.
Show
Schema for entity data updates.
data
object
Information about the data to be updated.
filters
array of object
Criteria applied to filter the shipments.
transition_comments
array of object (TransitionComments)
A list of comments or annotations provided during a status transition or data update on the shipment. Each comment helps capture the intent, context, or the user action performed — such as assigning a delivery partner, updating address, or retrying delivery. Useful for audit trails, communication, and debugging purposes.
Show
Schema used to capture comments or notes related to status transitions or data update actions on a shipment. It helps track the context and reason behind each change in the system.
title
string
A short, human-readable summary of the action being performed. For example, "Assigned Delivery Partner".
message
string
A detailed explanation of the action or change, including any important metadata such as AWB number, partner name, or identifiers. For example, "The Expressbees delivery partner is assigned to the shipment. AWB number: 132134131222, extension_id: 3dsa31230912039890210".
identifier
string
Required
The unique identifier for request which is the shipment_id.
refund_modes
array of object (RefundModeTransitionData)
Refund Mode for status transition.
Show
Refund Mode Transition Data for status transition.
refund_mode
string
Refund Mode for status transition data.
display_name
string
Refund Mode display name.
beneficiary_details
object (RefundModeTransitionBeneficiaryData)
Show
Refund Mode Transition Beneficiary Data for status transition.
beneficiary_id
string
Unique identifier for the beneficiary.
payment_identifiers
array of string
List of identifiers associated with the refund transaction.
exclude_bags_next_state
string
State to be change for Remaining Bag/Products.
status
string
The status to which the entity is to be transitioned.
task
boolean
Indicates whether the task is active or required.
lock_after_transition
boolean
Indicates whether the status should be locked after the transition.
force_transition
boolean
Indicates whether the transition should be forced.
unlock_before_transition
boolean
Indicates whether the status should be unlocked before the transition.
Request body
statuses
array of object (StatuesRequestSchema)
An array detailing the various statuses that the requester wants to transition to, with each entry representing a distinct status. Each status object includes comprehensive details about the status, product specifics, reasons for the status (if applicable), and any updates to shipment or product data.
Show
Schema for statuses.
shipments
array of object (ShipmentsRequestSchema)
A list containing information about shipments.
Show
Shipment Info.
reasons
object (ReasonsData)
Show
Schema for reasons data.
products
array of object (ProductsReasons)
Reasons data for bags.
Show
Reasons data for bags.
data
object (ProductsReasonsData)
Show
Product reasons details.
reason_id
integer
The unique identifier for the reason.
reason_text
string
The text describing the reason.
filters
array of object (ProductsReasonsFilters)
Criteria applied to filter the products.
Show
Reasons data for bags filters.
line_number
integer
The specific line item of bag.
quantity
integer
The quantity of the product.
identifier
string
The unique identifier for the product.
entities
array of object (EntitiesReasons)
Reasons data for shipments.
Show
Schema for entity reasons.
data
object (EntityReasonData)
Show
Information about the reason.
reason_id
integer
The unique identifier for the reason.
reason_text
string
The text describing the reason.
filters
array of object
Criteria applied to filter the shipment.
products
array of object (Products)
Specific bag to be updated.
Show
Schema for products.
line_number
integer
The specific line item of bag.
quantity
integer
The quantity of the product.
identifier
string
The unique identifier for the product.
data_updates
object (DataUpdates)
Show
Data to be updated.
products
array of object (ProductsDataUpdates)
Data updates for bags.
Show
Schema for product data updates.
data
object
Information about the data to be updated.
filters
array of object (ProductsDataUpdatesFilters)
Criteria applied to filter the products.
Show
Schema for products filters.
line_number
integer
| int32
Represents the specific line item within a bag, used to identify and reference a particular product in a list. This helps in pinpointing the exact item being updated or processed.
identifier
string
A unique string that serves as the product’s identifier, such as a SKU, barcode, or another distinct code. This ensures the product is correctly identified and distinguished from other items in the system.
quantity
integer
| int32
The quantity of the product or item, specified as an integer. This indicates how many units of the product are being referenced or processed, such as the number of items in a bag or shipment.
entities
array of object (EntitiesDataUpdates)
Data updates for shipments.
Show
Schema for entity data updates.
data
object
Information about the data to be updated.
filters
array of object
Criteria applied to filter the shipments.
transition_comments
array of object (TransitionComments)
A list of comments or annotations provided during a status transition or data update on the shipment. Each comment helps capture the intent, context, or the user action performed — such as assigning a delivery partner, updating address, or retrying delivery. Useful for audit trails, communication, and debugging purposes.
Show
Schema used to capture comments or notes related to status transitions or data update actions on a shipment. It helps track the context and reason behind each change in the system.
title
string
A short, human-readable summary of the action being performed. For example, "Assigned Delivery Partner".
message
string
A detailed explanation of the action or change, including any important metadata such as AWB number, partner name, or identifiers. For example, "The Expressbees delivery partner is assigned to the shipment. AWB number: 132134131222, extension_id: 3dsa31230912039890210".
identifier
string
Required
The unique identifier for request which is the shipment_id.
refund_modes
array of object (RefundModeTransitionData)
Refund Mode for status transition.
Show
Refund Mode Transition Data for status transition.
refund_mode
string
Refund Mode for status transition data.
display_name
string
Refund Mode display name.
beneficiary_details
object (RefundModeTransitionBeneficiaryData)
Show
Refund Mode Transition Beneficiary Data for status transition.
beneficiary_id
string
Unique identifier for the beneficiary.
payment_identifiers
array of string
List of identifiers associated with the refund transaction.
exclude_bags_next_state
string
State to be change for Remaining Bag/Products.
status
string
The status to which the entity is to be transitioned.
task
boolean
Indicates whether the task is active or required.
lock_after_transition
boolean
Indicates whether the status should be locked after the transition.
force_transition
boolean
Indicates whether the transition should be forced.
unlock_before_transition
boolean
Indicates whether the status should be unlocked before the transition.
PUT
Response
200
Success response
Hide
Schema for Shipment Application Status Response.
statuses
array of object (StatusesBodyResponseSchema)
An array containing different status options of shipments.
Show
Schema for Statuses body response.
shipments
array of object
List of shipments.
Examples
Parameters
body:
body
Response
Updates shipment status
updateShipmentStatus
This operation allows customers to submit a request for reattempting the delivery of a specific shipment with optional address updates and a new delivery date.
Parameters
shipment_idpath
string
Required
The unique identifier for the shipment.
bodyrequestBody
object (DeliveryReattemptRequestSchema)
Required
Hide
delivery_address
object
A dynamic object containing updated delivery address details, structured based on country-specific standards. For example, Indian addresses may include pincode and landmark, while UAE addresses doesn't contain pincode. To retrieve the address field structure for a specific country, use the getCountry operationID.
delivery_reschedule_date
string
| date-time
Required
Date and time for the rescheduled delivery attempt in ISO 8601 UTC format (e.g., 2025-06-07T10:00:00Z). This specifies when the customer wants the shipment to be redelivered.
remark
string
Required
A brief note provided by the customer explaining the reason for the reattempt request. For example, "Changing contact number", "Updated delivery address", or "Unavailable on previous date".
Request body
delivery_address
object
A dynamic object containing updated delivery address details, structured based on country-specific standards. For example, Indian addresses may include pincode and landmark, while UAE addresses doesn't contain pincode. To retrieve the address field structure for a specific country, use the getCountry operationID.
delivery_reschedule_date
string
| date-time
Required
Date and time for the rescheduled delivery attempt in ISO 8601 UTC format (e.g., 2025-06-07T10:00:00Z). This specifies when the customer wants the shipment to be redelivered.
remark
string
Required
A brief note provided by the customer explaining the reason for the reattempt request. For example, "Changing contact number", "Updated delivery address", or "Unavailable on previous date".
PUT
Response
200
400
403
Success response
Hide
message
string
A confirmation message indicating that your delivery reattempt has been scheduled successfully.
Response