Order
The Order and Shipment module is designed for retrieving application-specific orders, accessing order details, and obtaining shipment and invoice information. This module facilitates shipment tracking, allows customization of shipment details, and provides reasons for cancellations and returns. Additionally, it offers real-time shipment status updates.
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_id
string
Required
The unique identifier for the shipment
bag_id
string
Required
Identifier for a bag or product.
Response
200
404
A successful response
ShipmentBagReasons
reasons
array of object (BagReasons)
A list of reasons associated with the action, detailing the circumstances under which the rule is applied.
Array of BagReasons
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)
BagReasonMeta
show_text_area
boolean
Indicates whether to display a text box on the front end.
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.
Array of QuestionSet
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.
Array of BagReasons
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:
"16712173702241747844"
bag_id:
"6393"
Was this section helpful?
GET
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.
GET
# Tracks shipment status.
Parameters
status
integer
A filter to retrieve orders by their current status such as 'placed', 'delivered' etc.
page_no
integer
The page number to navigate through the given set of results. Default value is 1.
page_size
integer
The number of items to retrieve in each page. Default value is 10.
from_date
string
| date-time
The date from which the orders should be retrieved.
to_date
string
| date-time
The date till which the orders should be retrieved.
start_date
string
| date-time
Start date in UTC (ISO-8601 format).
end_date
string
| date-time
End date in UTC (ISO-8601 format).
custom_meta
string
A filter and retrieve data using special fields included for special use-cases.
Response
200
400
Success. Returns all the orders.
OrderList
page
object (OrderPage)
OrderPage
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 (OrderSchema)
List of orders, each containing detailed information about individual orders and their respective shipments.
Array of OrderSchema
coupon_details
array of object (CouponDetails)
An array of coupon details applied to the shipment.
Array of CouponDetails
display
string
label of the coupon in a human-readable format.
code
string
The actual coupon code used.
currency_symbol
string
The symbol of the currency for the discount
currency_code
string
The ISO 4217 currency code associated with the discount.
value
number
The discount amount applied using the coupon.
total_shipments_in_order
integer
The total number of shipments in the order.
custom_cart_meta
object
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)
UserInfo
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.
user_id
string
Unique identifier of the user.
breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Array of BreakupValues
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.
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.
Array of Shipments
advance_payment_config
object
Nullable
multi_mop_payments
object
Nullable
multi_mop_payments_list
array of object
Nullable
is_validated
boolean
refund_information
array of object
currency
object (CurrencySchema)
CurrencySchema
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.
currency_info
object (CurrencyInfo)
CurrencyInfo
ordering_currency
object (OrderingCurrency)
OrderingCurrency
currency_code
string
The international 3-letter code representing the currency.
currency_name
string
The full name of the currency.
currency_symbol
string
The graphical symbol used to denote the currency.
currency_sub_unit
string
The smaller unit of the currency for precise transactions.
conversion_rate
object (ConversionRate)
ConversionRate
base
string
rates
object
coupon_details
array of object (CouponDetails)
An array of coupon details applied to the shipment.
Array of CouponDetails
display
string
label of the coupon in a human-readable format.
code
string
The actual coupon code used.
currency_symbol
string
The symbol of the currency for the discount
currency_code
string
The ISO 4217 currency code associated with the discount.
value
number
The discount amount applied using the coupon.
meta
object
Nullable
Meta data of the shipment contains additional, potentially dynamic information about the shipment.
payment
object (ShipmentPayment)
ShipmentPayment
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 (PaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Array of PaymentInfo
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)
ShipmentUserInfo
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.
user_id
string
Unique identifier of the user.
shipment_id
string
The unique identifier for the shipment.
fulfilling_store
object (FulfillingStore)
FulfillingStore
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.
tags
array of string
custom_meta
array of object
An object containing custom metadata for the shipment.
shipment_status
object (ShipmentStatus)
ShipmentStatus
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)
Invoice
invoice_url
string
URL providing access to the invoice.
store_invoice_id
string
Nullable
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.
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.
Array of BreakupValues
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.
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.
Array of TrackingDetails
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.
Array of NestedTrackingDetails
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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
promise
object (Promise)
Promise
show_promise
boolean
Indicates whether the promise details should be shown.
timestamp
object (TimeStampData)
TimeStampData
min
string
The minimum timestamp value.
max
string
The maximum timestamp value.
dp_promise
string
Nullable
total_bags
integer
The total number of bags in the shipment.
total_details
object (ShipmentTotalDetails)
ShipmentTotalDetails
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)
Prices
applied_emi_discount
integer
applied_instant_discount
integer
gift_price
integer
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.
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.
Array of Bags
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)
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)
ItemBrand
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.
variants
object
Nullable
This represents different variants of items such as color, shade, material, storage variants, size and more.
applied_promos
array of object (AppliedPromos)
An array containing information about applied promotions.
Array of AppliedPromos
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.
Enum
applied_free_articles
array of object (AppliedFreeArticles)
An array containing details of free articles applied under the promotion.
Array of AppliedFreeArticles
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
number
The quantity of the item.
prices
object (Prices)
Prices
applied_emi_discount
integer
applied_instant_discount
integer
gift_price
integer
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.
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.
Array of FinancialBreakup
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)
Identifiers
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.
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)
CurrentStatus
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
Article
tags
array of string
Nullable
An array of tags associated with the article.
variants
object
Nullable
This represents different variants of items such as color, shade, material, storage variants, size and more.
charges
array of object (PriceAdjustmentCharge)
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
FulfillingCompany
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)
Address
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)
Address
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)
OrderRequestSchema
meta
object
Metadata for the order.
external_order_id
string
Nullable
Identifier of the order assigned by the application
can_pay_remaining_amount
boolean
charges
array of object (PriceAdjustmentCharge)
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
external_shipment_id
string
Nullable
Identifier of the shipment assigned by the application
previous_shipment_id
string
Nullable
ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition
is_refund_initiated
boolean
Indicates whether refund is initiated for the shipment.
bags_for_reorder
array of object (BagsForReorder)
Items to be added to the cart when reordering a previous purchase.
Array of BagsForReorder
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)
BagsForReorderArticleAssignment
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.
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
custom_meta
array of object
Nullable
currency_info
object (CurrencyInfo)
CurrencyInfo
ordering_currency
object (OrderingCurrency)
OrderingCurrency
currency_code
string
The international 3-letter code representing the currency.
currency_name
string
The full name of the currency.
currency_symbol
string
The graphical symbol used to denote the currency.
currency_sub_unit
string
The smaller unit of the currency for precise transactions.
conversion_rate
object (ConversionRate)
ConversionRate
base
string
rates
object
is_validated
boolean
meta
object
An object containing additional metadata for the order.
external_order_id
string
Nullable
Identifier of the order assigned by the application
payment_info
array of object (PaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Array of PaymentInfo
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
currency
object (CurrencySchema)
CurrencySchema
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.
custom_json
object
Nullable
An object containing additional metadata for the order, ensuring only the required fields are included as needed.
filters
object (OrderFilters)
OrderFilters
statuses
array of object (OrderStatuses)
An array containing the order statuses.
Array of OrderStatuses
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
status:
2
page_no:
1
page_size:
10
from_date:
"02-18-2024"
to_date:
"03-20-2024"
start_date:
"08-21-2024"
end_date:
"08-21-2024"
custom_meta:
"6388422a5ebd6a6cf4a8ede6"
Was this section helpful?
GET
Response
List customer orders
getOrders
Get order details such as tracking details, shipment, store information using Fynd Order ID.
Parameters
order_id
string
Required
A unique number used for identifying and tracking an order.
allow_inactive
boolean
Flag to allow inactive shipments.
Response
200
404
Success.
OrderById
order
object (OrderSchema)
OrderSchema
coupon_details
array of object (CouponDetails)
An array of coupon details applied to the shipment.
Array of CouponDetails
display
string
label of the coupon in a human-readable format.
code
string
The actual coupon code used.
currency_symbol
string
The symbol of the currency for the discount
currency_code
string
The ISO 4217 currency code associated with the discount.
value
number
The discount amount applied using the coupon.
total_shipments_in_order
integer
The total number of shipments in the order.
custom_cart_meta
object
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)
UserInfo
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.
user_id
string
Unique identifier of the user.
breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Array of BreakupValues
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.
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.
Array of Shipments
advance_payment_config
object
Nullable
multi_mop_payments
object
Nullable
multi_mop_payments_list
array of object
Nullable
is_validated
boolean
refund_information
array of object
currency
object (CurrencySchema)
CurrencySchema
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.
currency_info
object (CurrencyInfo)
CurrencyInfo
ordering_currency
object (OrderingCurrency)
OrderingCurrency
currency_code
string
The international 3-letter code representing the currency.
currency_name
string
The full name of the currency.
currency_symbol
string
The graphical symbol used to denote the currency.
currency_sub_unit
string
The smaller unit of the currency for precise transactions.
conversion_rate
object (ConversionRate)
ConversionRate
base
string
rates
object
coupon_details
array of object (CouponDetails)
An array of coupon details applied to the shipment.
Array of CouponDetails
display
string
label of the coupon in a human-readable format.
code
string
The actual coupon code used.
currency_symbol
string
The symbol of the currency for the discount
currency_code
string
The ISO 4217 currency code associated with the discount.
value
number
The discount amount applied using the coupon.
meta
object
Nullable
Meta data of the shipment contains additional, potentially dynamic information about the shipment.
payment
object (ShipmentPayment)
ShipmentPayment
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 (PaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Array of PaymentInfo
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)
ShipmentUserInfo
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.
user_id
string
Unique identifier of the user.
shipment_id
string
The unique identifier for the shipment.
fulfilling_store
object (FulfillingStore)
FulfillingStore
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.
tags
array of string
custom_meta
array of object
An object containing custom metadata for the shipment.
shipment_status
object (ShipmentStatus)
ShipmentStatus
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)
Invoice
invoice_url
string
URL providing access to the invoice.
store_invoice_id
string
Nullable
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.
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.
Array of BreakupValues
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.
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.
Array of TrackingDetails
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.
Array of NestedTrackingDetails
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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
promise
object (Promise)
Promise
show_promise
boolean
Indicates whether the promise details should be shown.
timestamp
object (TimeStampData)
TimeStampData
min
string
The minimum timestamp value.
max
string
The maximum timestamp value.
dp_promise
string
Nullable
total_bags
integer
The total number of bags in the shipment.
total_details
object (ShipmentTotalDetails)
ShipmentTotalDetails
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)
Prices
applied_emi_discount
integer
applied_instant_discount
integer
gift_price
integer
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.
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.
Array of Bags
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)
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)
ItemBrand
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.
variants
object
Nullable
This represents different variants of items such as color, shade, material, storage variants, size and more.
applied_promos
array of object (AppliedPromos)
An array containing information about applied promotions.
Array of AppliedPromos
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.
Enum
applied_free_articles
array of object (AppliedFreeArticles)
An array containing details of free articles applied under the promotion.
Array of AppliedFreeArticles
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
number
The quantity of the item.
prices
object (Prices)
Prices
applied_emi_discount
integer
applied_instant_discount
integer
gift_price
integer
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.
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.
Array of FinancialBreakup
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)
Identifiers
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.
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)
CurrentStatus
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
Article
tags
array of string
Nullable
An array of tags associated with the article.
variants
object
Nullable
This represents different variants of items such as color, shade, material, storage variants, size and more.
charges
array of object (PriceAdjustmentCharge)
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
FulfillingCompany
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)
Address
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)
Address
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)
OrderRequestSchema
meta
object
Metadata for the order.
external_order_id
string
Nullable
Identifier of the order assigned by the application
can_pay_remaining_amount
boolean
charges
array of object (PriceAdjustmentCharge)
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
external_shipment_id
string
Nullable
Identifier of the shipment assigned by the application
previous_shipment_id
string
Nullable
ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition
is_refund_initiated
boolean
Indicates whether refund is initiated for the shipment.
bags_for_reorder
array of object (BagsForReorder)
Items to be added to the cart when reordering a previous purchase.
Array of BagsForReorder
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)
BagsForReorderArticleAssignment
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.
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
custom_meta
array of object
Nullable
currency_info
object (CurrencyInfo)
CurrencyInfo
ordering_currency
object (OrderingCurrency)
OrderingCurrency
currency_code
string
The international 3-letter code representing the currency.
currency_name
string
The full name of the currency.
currency_symbol
string
The graphical symbol used to denote the currency.
currency_sub_unit
string
The smaller unit of the currency for precise transactions.
conversion_rate
object (ConversionRate)
ConversionRate
base
string
rates
object
is_validated
boolean
meta
object
An object containing additional metadata for the order.
external_order_id
string
Nullable
Identifier of the order assigned by the application
payment_info
array of object (PaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Array of PaymentInfo
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
currency
object (CurrencySchema)
CurrencySchema
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.
custom_json
object
Nullable
An object containing additional metadata for the order, ensuring only the required fields are included as needed.
Examples
Parameters
order_id:
"FY6119EF9A0185F48339"
allow_inactive:
true
Was this section helpful?
GET
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_id
string
Required
A unique number used for identifying and tracking your orders.
Response
200
404
Success. Check the example shown below or refer `PosOrderById` for more details.
OrderById
order
object (OrderSchema)
OrderSchema
coupon_details
array of object (CouponDetails)
An array of coupon details applied to the shipment.
Array of CouponDetails
display
string
label of the coupon in a human-readable format.
code
string
The actual coupon code used.
currency_symbol
string
The symbol of the currency for the discount
currency_code
string
The ISO 4217 currency code associated with the discount.
value
number
The discount amount applied using the coupon.
total_shipments_in_order
integer
The total number of shipments in the order.
custom_cart_meta
object
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)
UserInfo
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.
user_id
string
Unique identifier of the user.
breakup_values
array of object (BreakupValues)
An array containing the breakup of various charges and discounts.
Array of BreakupValues
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.
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.
Array of Shipments
advance_payment_config
object
Nullable
multi_mop_payments
object
Nullable
multi_mop_payments_list
array of object
Nullable
is_validated
boolean
refund_information
array of object
currency
object (CurrencySchema)
CurrencySchema
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.
currency_info
object (CurrencyInfo)
CurrencyInfo
ordering_currency
object (OrderingCurrency)
OrderingCurrency
currency_code
string
The international 3-letter code representing the currency.
currency_name
string
The full name of the currency.
currency_symbol
string
The graphical symbol used to denote the currency.
currency_sub_unit
string
The smaller unit of the currency for precise transactions.
conversion_rate
object (ConversionRate)
ConversionRate
base
string
rates
object
coupon_details
array of object (CouponDetails)
An array of coupon details applied to the shipment.
Array of CouponDetails
display
string
label of the coupon in a human-readable format.
code
string
The actual coupon code used.
currency_symbol
string
The symbol of the currency for the discount
currency_code
string
The ISO 4217 currency code associated with the discount.
value
number
The discount amount applied using the coupon.
meta
object
Nullable
Meta data of the shipment contains additional, potentially dynamic information about the shipment.
payment
object (ShipmentPayment)
ShipmentPayment
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 (PaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Array of PaymentInfo
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)
ShipmentUserInfo
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.
user_id
string
Unique identifier of the user.
shipment_id
string
The unique identifier for the shipment.
fulfilling_store
object (FulfillingStore)
FulfillingStore
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.
tags
array of string
custom_meta
array of object
An object containing custom metadata for the shipment.
shipment_status
object (ShipmentStatus)
ShipmentStatus
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)
Invoice
invoice_url
string
URL providing access to the invoice.
store_invoice_id
string
Nullable
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.
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.
Array of BreakupValues
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.
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.
Array of TrackingDetails
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.
Array of NestedTrackingDetails
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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
promise
object (Promise)
Promise
show_promise
boolean
Indicates whether the promise details should be shown.
timestamp
object (TimeStampData)
TimeStampData
min
string
The minimum timestamp value.
max
string
The maximum timestamp value.
dp_promise
string
Nullable
total_bags
integer
The total number of bags in the shipment.
total_details
object (ShipmentTotalDetails)
ShipmentTotalDetails
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)
Prices
applied_emi_discount
integer
applied_instant_discount
integer
gift_price
integer
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.
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.
Array of Bags
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)
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)
ItemBrand
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.
variants
object
Nullable
This represents different variants of items such as color, shade, material, storage variants, size and more.
applied_promos
array of object (AppliedPromos)
An array containing information about applied promotions.
Array of AppliedPromos
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.
Enum
applied_free_articles
array of object (AppliedFreeArticles)
An array containing details of free articles applied under the promotion.
Array of AppliedFreeArticles
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
number
The quantity of the item.
prices
object (Prices)
Prices
applied_emi_discount
integer
applied_instant_discount
integer
gift_price
integer
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.
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.
Array of FinancialBreakup
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)
Identifiers
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.
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)
CurrentStatus
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
Article
tags
array of string
Nullable
An array of tags associated with the article.
variants
object
Nullable
This represents different variants of items such as color, shade, material, storage variants, size and more.
charges
array of object (PriceAdjustmentCharge)
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
FulfillingCompany
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)
Address
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)
Address
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)
OrderRequestSchema
meta
object
Metadata for the order.
external_order_id
string
Nullable
Identifier of the order assigned by the application
can_pay_remaining_amount
boolean
charges
array of object (PriceAdjustmentCharge)
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
external_shipment_id
string
Nullable
Identifier of the shipment assigned by the application
previous_shipment_id
string
Nullable
ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition
is_refund_initiated
boolean
Indicates whether refund is initiated for the shipment.
bags_for_reorder
array of object (BagsForReorder)
Items to be added to the cart when reordering a previous purchase.
Array of BagsForReorder
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)
BagsForReorderArticleAssignment
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.
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
custom_meta
array of object
Nullable
currency_info
object (CurrencyInfo)
CurrencyInfo
ordering_currency
object (OrderingCurrency)
OrderingCurrency
currency_code
string
The international 3-letter code representing the currency.
currency_name
string
The full name of the currency.
currency_symbol
string
The graphical symbol used to denote the currency.
currency_sub_unit
string
The smaller unit of the currency for precise transactions.
conversion_rate
object (ConversionRate)
ConversionRate
base
string
rates
object
is_validated
boolean
meta
object
An object containing additional metadata for the order.
external_order_id
string
Nullable
Identifier of the order assigned by the application
payment_info
array of object (PaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Array of PaymentInfo
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
currency
object (CurrencySchema)
CurrencySchema
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.
custom_json
object
Nullable
An object containing additional metadata for the order, ensuring only the required fields are included as needed.
Examples
Parameters
order_id:
"FY6119EF9A0185F48339"
Was this section helpful?
GET
Response
Retrieves POS order details.
getPosOrderById
Parameters
shipment_id
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.
Response
200
400
Success.
ShipmentTrack
success
boolean
meta
object
Nullable
results
array of object (Track)
A array containing tracking details.
Array of Track
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.
raw_status
string
meta
object
A field to store additional metadata related to the courier partner's operations or the shipment.
Examples
Parameters
shipment_id:
"16691355532841431595"
Was this section helpful?
GET
Response
Tracks shipment status.
trackShipment
The Refund resource has two major components: - Transaction summary of money returned to the customer through multiple MOPs - Refund options available against shipment id at present
Operations
GET
# Retreives shipment's refund summary.
GET
# Retrieve refund options with amount breakup for specific shipment and bags.
Parameters
shipment_id
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.
Response
200
404
Success. Check the example shown below or refer `ShipmentRefundSummaries` for more details.
ShipmentRefundSummaryResponseSchema
refund_summary
array of object (ShipmentRefundSummary)
Array of ShipmentRefundSummary
amount
number
Refund amount using this particular payment method.
mode
string
Stands for "Mode of Payment". This is a short code (like "COD" for Cash On Delivery) that represents the payment method used.
mode_display_name
string
The name of the payment method as it should be displayed to the user
refund_status
string
Indicates the current status of the refund
refund_initiated_at
string
| date-time
Indicates UTC time at which the refund was initiated
refund_updated_at
string
| date-time
Indicates UTC time at which the refund was last updated
meta
object (ShipmentRefundSummaryMeta)
ShipmentRefundSummaryMeta
utr
string
Nullable
Indicates UTR number of the refund transaction
currency
object (OrderingCurrency)
OrderingCurrency
currency_code
string
The international 3-letter code representing the currency.
currency_name
string
The full name of the currency.
currency_symbol
string
The graphical symbol used to denote the currency.
currency_sub_unit
string
The smaller unit of the currency for precise transactions.
Examples
Parameters
shipment_id:
"16722505549091367924"
Was this section helpful?
GET
Response
Retreives shipment's refund summary.
getShipmentRefundSummary
This API can be used for giving the refund amount with available option of MOPs.
Parameters
shipment_id
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.
bag_ids
string
It is the bag_id of the bags with comma separated.
state
string
It is the desired state at which refund amount needs to be calculated.
optin_app_id
string
It is affiliate id of the order in case of cross selling.
optin_company_id
integer
It is company id of the order in case of cross selling.
status
string
It specifies the desired status to which the shipment should be updated. It represents the next step in the shipment's lifecycle, such as being cancelled by the customer or moved to another status in the shipping process.
Response
200
refund option response.
RefundOptionsSchemaResponseSchema
success
boolean
currency
object (CurrencySchema)
CurrencySchema
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.
refund_options
array of object (RefundOptionShipmentResponseSchema)
Array of RefundOptionShipmentResponseSchema
id
integer
| int32
ID of the refund option
name
string
Name of the refund option
display_name
string
Display name of the refund option
is_active
boolean
Whether the refund option is active
breakups
array of object (RefundBreakup)
List of refund breakups (optional)
Array of RefundBreakup
mode
string
Specifies the method or channel through which the refund is divided or processed, such as Online or Offline. This indicates how the refund amount is split across different refund methods.
amount
number
| float
Amount for the refund breakup
display_name
string
Display name for the refund breakup mode
offline
boolean
Whether the breakup is offline
option
array of object (RefundSubOption)
List of sub-options for the refund option
Array of RefundSubOption
id
integer
| int32
ID of the refund sub-option
name
string
Name of the refund sub-option
display_name
string
Display name of the refund sub-option
is_active
boolean
Whether the refund sub-option is active
offline
boolean
Whether the refund option is offline
amount
number
| float
Amount for the refund option (optional)
Examples
Parameters
shipment_id:
"17171553441681910006"
bag_ids:
"21248920"
state:
"cancelled_customer"
optin_app_id:
"5e2fafc88b352fdcbc49fa30"
optin_company_id:
123
status:
"cancelled_customer"
Was this section helpful?
GET
Response
Retrieve refund options with amount breakup for specific shipment and bags.
getRefundOptions
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
# Fetches shipment by ID.
GET
# Retrieves invoice for shipment.
GET
# Retrieves shipment customer.
POST
# Sends OTP to customer.
POST
# Verifies OTP.
GET
# Lists shipment reasons.
PUT
# Updates shipment status.
Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID.
Parameters
shipment_id
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_inactive
boolean
Flag to allow inactive shipments.
Default Value : false
Response
200
404
Success. Check the example shown below or refer `ShipmentById` for more details.
ShipmentById
shipment
object (Shipments)
Shipments
advance_payment_config
object
Nullable
multi_mop_payments
object
Nullable
multi_mop_payments_list
array of object
Nullable
is_validated
boolean
refund_information
array of object
currency
object (CurrencySchema)
CurrencySchema
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.
currency_info
object (CurrencyInfo)
CurrencyInfo
ordering_currency
object (OrderingCurrency)
OrderingCurrency
currency_code
string
The international 3-letter code representing the currency.
currency_name
string
The full name of the currency.
currency_symbol
string
The graphical symbol used to denote the currency.
currency_sub_unit
string
The smaller unit of the currency for precise transactions.
conversion_rate
object (ConversionRate)
ConversionRate
base
string
rates
object
coupon_details
array of object (CouponDetails)
An array of coupon details applied to the shipment.
Array of CouponDetails
display
string
label of the coupon in a human-readable format.
code
string
The actual coupon code used.
currency_symbol
string
The symbol of the currency for the discount
currency_code
string
The ISO 4217 currency code associated with the discount.
value
number
The discount amount applied using the coupon.
meta
object
Nullable
Meta data of the shipment contains additional, potentially dynamic information about the shipment.
payment
object (ShipmentPayment)
ShipmentPayment
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 (PaymentInfo)
Array of objects containing payment methods used for placing an order. Each object will provide information about corresponding payment method with relevant details.
Array of PaymentInfo
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)
ShipmentUserInfo
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.
user_id
string
Unique identifier of the user.
shipment_id
string
The unique identifier for the shipment.
fulfilling_store
object (FulfillingStore)
FulfillingStore
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.
tags
array of string
custom_meta
array of object
An object containing custom metadata for the shipment.
shipment_status
object (ShipmentStatus)
ShipmentStatus
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)
Invoice
invoice_url
string
URL providing access to the invoice.
store_invoice_id
string
Nullable
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.
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.
Array of BreakupValues
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.
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.
Array of TrackingDetails
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.
Array of NestedTrackingDetails
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.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
promise
object (Promise)
Promise
show_promise
boolean
Indicates whether the promise details should be shown.
timestamp
object (TimeStampData)
TimeStampData
min
string
The minimum timestamp value.
max
string
The maximum timestamp value.
dp_promise
string
Nullable
total_bags
integer
The total number of bags in the shipment.
total_details
object (ShipmentTotalDetails)
ShipmentTotalDetails
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)
Prices
applied_emi_discount
integer
applied_instant_discount
integer
gift_price
integer
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.
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.
Array of Bags
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)
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)
ItemBrand
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.
variants
object
Nullable
This represents different variants of items such as color, shade, material, storage variants, size and more.
applied_promos
array of object (AppliedPromos)
An array containing information about applied promotions.
Array of AppliedPromos
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.
Enum
applied_free_articles
array of object (AppliedFreeArticles)
An array containing details of free articles applied under the promotion.
Array of AppliedFreeArticles
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
number
The quantity of the item.
prices
object (Prices)
Prices
applied_emi_discount
integer
applied_instant_discount
integer
gift_price
integer
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.
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.
Array of FinancialBreakup
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)
Identifiers
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.
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)
CurrentStatus
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
Article
tags
array of string
Nullable
An array of tags associated with the article.
variants
object
Nullable
This represents different variants of items such as color, shade, material, storage variants, size and more.
charges
array of object (PriceAdjustmentCharge)
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
FulfillingCompany
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)
Address
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)
Address
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)
OrderRequestSchema
meta
object
Metadata for the order.
external_order_id
string
Nullable
Identifier of the order assigned by the application
can_pay_remaining_amount
boolean
charges
array of object (PriceAdjustmentCharge)
Array of PriceAdjustmentCharge
code
string
Nullable
Code defined for charge
name
string
Nullable
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
ChargeAmount
base_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
ChargeAmountCurrency
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
ChargeDistributionLogic
distribution
object (ChargeDistributionSchema)
ChargeDistributionSchema
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the charges across all entity
single: distribute the charges 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 specifies the level of distribution, such as order, shipment, or article
external_shipment_id
string
Nullable
Identifier of the shipment assigned by the application
previous_shipment_id
string
Nullable
ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition
is_refund_initiated
boolean
Indicates whether refund is initiated for the shipment.
Examples
Parameters
shipment_id:
"16712173702241747844"
allow_inactive:
true
Was this section helpful?
GET
Response
Fetches shipment by ID.
getShipmentById
Parameters
shipment_id
string
Required
Unique identifier for a shipment.
Response
200
404
Success.
ResponseGetInvoiceShipment
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.
entity_id
string
expires_in
integer
url
string
Examples
Parameters
shipment_id:
"16712173702241747844"
Was this section helpful?
GET
Response
Retrieves invoice for shipment.
getInvoiceByShipmentId
Parameters
order_id
string
Required
A unique number used for identifying and tracking your orders.
shipment_id
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.
Response
200
404
Success.
CustomerDetailsResponseSchema
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
order_id:
"FY6119EF9A0185F48339"
shipment_id:
"16290896910211243162"
Was this section helpful?
GET
Response
Retrieves shipment customer.
getCustomerDetailsByShipmentId
Parameters
order_id
string
Required
A unique number used for identifying and tracking your orders.
shipment_id
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.
Response
200
404
Success to acknowledge the service was notified
SendOtpToCustomerResponseSchema
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
order_id:
"FY6119EF9A0185F48339"
shipment_id:
"16290896910211243162"
Was this section helpful?
POST
Response
Sends OTP to customer.
sendOtpToShipmentCustomer
Parameters
order_id
string
Required
A string that represents the unique identifier assigned to the order.
shipment_id
string
Required
The unique identifier for the shipment.
Request body
otp_code
string
The OTP code provided by the user for verification.
request_id
string
Unique identifier for the request.
Response
200
400
Success, the code is valid and returns a session token
VerifyOtpResponseSchema
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
order_id:
"FYMP6294545C010B89FD"
shipment_id:
"16538880933361957252J"
body:
body
Was this section helpful?
POST
Response
Verifies OTP.
verifyOtpShipmentCustomer
Parameters
shipment_id
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.
Response
200
404
Success.
ShipmentReasons
reasons
array of object (ShipmentReason)
A list of shipment reasons.
Array of ShipmentReason
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
shipment_id:
"16290896910211243162"
Was this section helpful?
GET
Response
Lists shipment 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_id
string
Required
The unique identifier for the shipment.
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.
Array of StatuesRequestSchema
shipments
array of object (ShipmentsRequestSchema)
A list containing information about shipments.
Array of ShipmentsRequestSchema
reasons
object (ReasonsData)
ReasonsData
products
array of object (ProductsReasons)
Reasons data for bags.
Array of ProductsReasons
data
object (ProductsReasonsData)
ProductsReasonsData
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.
Array of ProductsReasonsFilters
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.
Array of EntitiesReasons
data
object (EntityReasonData)
EntityReasonData
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.
Array of 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)
DataUpdates
products
array of object (ProductsDataUpdates)
Data updates for bags.
Array of ProductsDataUpdates
data
object
Information about the data to be updated.
filters
array of object (ProductsDataUpdatesFilters)
Criteria applied to filter the products.
Array of ProductsDataUpdatesFilters
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.
Array of EntitiesDataUpdates
data
object
Information about the data to be updated.
filters
array of object
Criteria applied to filter the shipments.
identifier
string
Required
The unique identifier for request which is the shipment_id.
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.
Response
200
Success response
ShipmentApplicationStatusResponseSchema
statuses
array of object (StatusesBodyResponseSchema)
An array containing different status options of shipments.
Array of StatusesBodyResponseSchema
shipments
array of object
List of shipments.
Examples
Parameters
shipment_id:
"16722505549091367924"
body:
body
Was this section helpful?
PUT
Response