Order

Manages orders, including processing, tracking, and updating order status.

Bag

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

/service/application/order/v1.0/orders/shipments/{shipment_id}/bags/{bag_id}/reasons

# Retrieve Reasons for Cancellation and Return journey

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

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

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

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

Parameters are not required.

Was this section helpful?

GET

/service/application/order/v1.0/orders/shipments/{shipment_id}/bags/{bag_id}/reasons

1curl -X GET "https://api.fynd.com/service/application/order/v1.0/orders/shipments/{shipment_id}/bags/{bag_id}/reasons" 
2 -H 'Authorization: Bearer {authorization_token}'

Try it

Response

1{
2  "success": true,
3  "rule_id": 23,
4  "reasons": [
5    {
6      "id": 87,
7      "display_name": "Others",
8      "meta": {
9        "show_text_area": true
10      },
11      "qc_type": [],
12      "question_set": [],
13      "reasons": []
14    },
15    {
16      "id": 84,
17      "display_name": "Changed my mind",
18      "meta": {
19        "show_text_area": false
20      },
21      "qc_type": [
22        "pre_qc",
23        "doorstep_qc"
24      ],
25      "question_set": [
26        {
27          "id": 1,
28          "display_name": "Check formal-shirt size."
29        }
30      ],
31      "reasons": [
32        {
33          "id": 86,
34          "display_name": "Found better price elsewhere",
35          "meta": {
36            "show_text_area": false
37          },
38          "qc_type": [],
39          "question_set": [],
40          "reasons": []
41        },
42        {
43          "id": 162,
44          "display_name": "Myntra VFS",
45          "meta": {
46            "show_text_area": false
47          },
48          "qc_type": [],
49          "question_set": [],
50          "reasons": [
51            {
52              "id": 85,
53              "display_name": "Delivery address is wrong",
54              "meta": {
55                "show_text_area": false
56              },
57              "qc_type": [],
58              "question_set": [],
59              "reasons": []
60            },
61            {
62              "id": 163,
63              "display_name": "Myntra VFS",
64              "meta": {
65                "show_text_area": false
66              },
67              "qc_type": [],
68              "question_set": [],
69              "reasons": []
70            }
71          ]
72        }
73      ]
74    }
75  ]
76}

Order

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

/service/application/order/v1.0/orders

# List customer orders

GET

/service/application/order/v1.0/orders/{order_id}

# Get an order

GET

/service/application/order/v1.0/orders/pos-order/{order_id}

# Retrieves POS order details

GET

List customer orders

Get all orders associated with a customer account.

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

The date from which the orders should be retrieved.

to_date

string

| date

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.

Default Value : 6388422a5ebd6a6cf4a8ede6

allow_inactive

boolean

Flag indicating whether inactive shipments are allowed.

Default Value : false

Response

200

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

total_shipments_in_order

integer

The total number of shipments in the order.

gstin_code

string

A GST Number (Goods and Services Tax Identification Number, often abbreviated as GSTIN) is a unique identifier assigned to a business or individual registered under the Goods and Services Tax (GST) system in countries like India. The GST number is essential for businesses to comply with tax regulations and for the government to track tax payments and returns.

user_info

object (UserInfo)

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.

string

Email address 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

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 (ShipmentPaymentInfo)

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 ShipmentPaymentInfo

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

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.

string

Email address of the user.

shipment_id

string

The unique identifier for the shipment.

fulfilling_store

object (FulfillingStore)

FulfillingStore

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

Schema for fulfilling store.

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.

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

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.

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.

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

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.

number

The unique identifier of the item.

name

string

The name of the item.

l3_category_name

string

This key specifies the name of the third-level category under which the product is listed, offering a more detailed classification within the e-commerce platform's hierarchy.

slug_key

string

A unique key or identifier for the item slug.

l2_categories

array of string

An array of level 2 categories the item belongs to.

size

string

The size of the item.

attributes

object

An object containing various attributes of the item.

applied_promos

array of object (AppliedPromos)

An array containing information about applied promotions.

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. - item_based_discount- Specific percentage discounts on selected items based on their position after sorting by price in descending order.

Enum

applied_free_articles

array of object (AppliedFreeArticles)

An array containing details of free articles applied under the promotion.

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

integer

The quantity of the item.

prices

object (Prices)

Prices

delivery_charge

number

The delivery charge for the order.

coupon_value

number

The value of the coupon applied.

brand_calculated_amount

number

The amount calculated by the brand.

value_of_good

number

The value of the goods before tax and other charges.

price_marked

number

The original marked price of the item.

coupon_effective_discount

number

The effective discount from coupons.

currency_symbol

string

The symbol of the currency used.

discount

number

The discount applied to the item.

gst_tax_percentage

number

The GST tax percentage applied.

cod_charges

number

The cash on delivery charges, if applicable.

amount_paid

number

The total amount paid by the customer.

added_to_fynd_cash

boolean

Indicates if the refund amount was added to Fynd Cash.

transfer_price

number

The transfer price of the item.

cashback_applied

number

The amount of cashback applied.

price_effective

number

The effective price after all adjustments.

cashback

number

The cashback amount earned.

refund_credit

number

The amount credited for refund .

amount_paid_roundoff

number

The rounded-off amount paid by the customer.

promotion_effective_discount

number

The effective discount from promotions.

refund_amount

number

The amount refunded to the customer.

currency_code

string

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.

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

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

An array of tags associated with the article.

charges

array of object (PriceAdjustmentCharge)

An array of charges associated with the order item.

Array of PriceAdjustmentCharge

code

string

Nullable

Code defined for charge

name

string

Display name for charge (charge is unique by the name)

type

string

Nullable

Type defined for charge

amount

object (ChargeAmount)

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with [10, 20] will get charge of 9 as [3, 6]) equally: distribute charge amount 'equally' to all the entity

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

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

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

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

Enum

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.

charges

array of object (PriceAdjustmentCharge)

An array of charge objects associated with the shipment.

Array of PriceAdjustmentCharge

code

string

Nullable

Code defined for charge

name

string

Display name for charge (charge is unique by the name)

type

string

Nullable

Type defined for charge

amount

object (ChargeAmount)

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

bags_for_reorder

array of object (BagsForReorder)

Items to be added to the cart when reordering a previous purchase.

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

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

meta

object

An object containing additional metadata for the order.

currency

object (CurrencySchema)

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.

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

page_no:

Was this section helpful?

GET

/service/application/order/v1.0/orders

1curl -X GET "https://api.fynd.com/service/application/order/v1.0/orders" 
2 -H 'Authorization: Bearer {authorization_token}'

Try it

Response

1{
2  "items": [
3    {
4      "order": null,
5      "bags_for_reorder": [
6        {
7          "item_id": 7500429,
8          "item_size": "OS",
9          "store_id": 50,
10          "seller_id": 33,
11          "article_assignment": {
12            "level": "multi-companies",
13            "strategy": "low-price"
14          },
15          "quantity": 3
16        }
17      ],
18      "gstin_code": "27AALCA0442L1ZM",
19      "user_info": {
20        "mobile": "8888888888",
21        "first_name": "User",
22        "last_name": "-",
23        "gender": "male"
24      },
25      "order_created_time": "2022-09-23T12:07:20.000Z",
26      "total_shipments_in_order": 2,
27      "order_id": "FY632D541F01152493D0",
28      "charges": [],
29      "breakup_values": [
30        {
31          "name": "mrp_total",
32          "display": "MRP Total",
33          "value": 3000
34        },
35        {
36          "name": "sub_total",
37          "display": "Sub Total",
38          "value": 1797
39        },
40        {
41          "name": "coupon",
42          "display": "Coupon",
43          "value": 0
44        },
45        {
46          "name": "discount",
47          "display": "Discount",
48          "value": -1203
49        },
50        {
51          "name": "promotion",
52          "display": "Promotion",
53          "value": 0
54        },
55        {
56          "name": "reward_points",
57          "display": "Reward Points",
58          "value": 0
59        },
60        {
61          "name": "cashback_applied",
62          "display": "Cashback Applied",
63          "value": 0
64        },
65        {
66          "name": "delivery_charges",
67          "display": "Delivery Charges",
68          "value": 0
69        },
70        {
71          "name": "cod_charges",
72          "display": "COD Charges",
73          "value": 0
74        },
75        {
76          "name": "amount_to_be_collected",
77          "display": "Amount To Be Collected",
78          "value": 0
79        },
80        {
81          "name": "Delivery Charge 2",
82          "display": "Delivery Charge 2",
83          "value": 100
84        },
85        {
86          "name": "total",
87          "display": "Total",
88          "value": 1897
89        }
90      ],
91      "shipments": [
92        {
93          "order_id": "FY632D541F01152493D0",
94          "order": {
95            "meta": {
96              "custom_cart_id": "652ce6972512f05477a32547",
97              "name": "Universal/Smart Bazar/Fresh Cart",
98              "slug": "universal/smart-bazar/fresh-cart"
99            },
100            "charges": [
101              {
102                "code": "Delivery Charge 2",
103                "name": "Delivery Charge 2",
104                "type": "charge",
105                "amount": {
106                  "base_currency": {
107                    "value": 100,
108                    "currency": "INR"
109                  },
110                  "ordering_currency": {
111                    "value": 100,
112                    "currency": "INR"
113                  }
114                },
115                "distribution_logic": {
116                  "distribution": {
117                    "rule": {
118                      "conditions": {
119                        "department": [
120                          "elect",
121                          "groceries"
122                        ],
123                        "article_tag": "1p"
124                      }
125                    },
126                    "type": "multi",
127                    "logic": "apportion"
128                  },
129                  "distribution_level": "shipment"
130                }
131              }
132            ]
133          },
134          "breakup_values": [
135            {
136              "name": "mrp_total",
137              "display": "MRP Total",
138              "value": 2000
139            },
140            {
141              "name": "sub_total",
142              "display": "Sub Total",
143              "value": 1198
144            },
145            {
146              "name": "coupon",
147              "display": "Coupon",
148              "value": 0
149            },
150            {
151              "name": "discount",
152              "display": "Discount",
153              "value": -802
154            },
155            {
156              "name": "promotion",
157              "display": "Promotion",
158              "value": 0
159            },
160            {
161              "name": "reward_points",
162              "display": "Reward Points",
163              "value": 0
164            },
165            {
166              "name": "cashback_applied",
167              "display": "Cashback Applied",
168              "value": 0
169            },
170            {
171              "name": "delivery_charges",
172              "display": "Delivery Charges",
173              "value": 0
174            },
175            {
176              "name": "cod_charges",
177              "display": "COD Charges",
178              "value": 0
179            },
180            {
181              "name": "amount_to_be_collected",
182              "display": "Amount To Be Collected",
183              "value": 0
184            },
185            {
186              "name": "Delivery Charge 2",
187              "display": "Delivery Charge 2",
188              "value": 100
189            },
190            {
191              "name": "total",
192              "display": "Total",
193              "value": 1298
194            }
195          ],
196          "beneficiary_details": false,
197          "shipment_created_at": "2022-09-23T12:07:35.000Z",
198          "shipment_id": "16639150404761166748K",
199          "shipment_status": {
200            "title": "Placed",
201            "value": "processing",
202            "hex_code": "#02D1CB"
203          },
204          "track_url": "",
205          "traking_no": "",
206          "awb_no": "",
207          "dp_name": "",
208          "tracking_details": [
209            {
210              "status": "Order Placed",
211              "time": "2022-09-23T12:07:35.000Z",
212              "is_passed": true,
213              "value": "processing"
214            },
215            {
216              "status": "Order Confirmed",
217              "time": "",
218              "is_passed": false,
219              "value": "confirmed"
220            },
221            {
222              "status": "Delivery Partner Assigned",
223              "time": "",
224              "is_passed": false,
225              "value": "dp_assigned"
226            },
227            {
228              "status": "In Transit",
229              "time": "",
230              "is_passed": false,
231              "value": "in_transit"
232            },
233            {
234              "status": "Out For Delivery",
235              "time": "",
236              "is_passed": false,
237              "value": "out_for_delivery"
238            },
239            {
240              "status": "Delivered",
241              "time": "",
242              "is_passed": false,
243              "value": "delivered"
244            }
245          ],
246          "total_bags": 1,
247          "order_type": "HomeDelivery",
248          "promise": {
249            "show_promise": true,
250            "timestamp": {
251              "dp_promise": null,
252              "min": "2022-09-26T06:37:17.000Z",
253              "max": "2022-09-27T06:37:17.000Z"
254            }
255          },
256          "bags": [
257            {
258              "id": 67631,
259              "current_status": {
260                "status": "placed",
261                "updated_at": "2022-09-23T12:07:35.000Z",
262                "name": "Placed",
263                "journey_type": "forward"
264              },
265              "charges": [],
266              "prices": {
267                "price_effective": 599,
268                "discount": 401,
269                "amount_paid": 599,
270                "coupon_effective_discount": 0,
271                "delivery_charge": 0,
272                "fynd_credits": 0,
273                "cod_charges": 0,
274                "refund_credit": 0,
275                "cashback": 0,
276                "refund_amount": 599,
277                "added_to_fynd_cash": false,
278                "cashback_applied": 0,
279                "gst_tax_percentage": 5,
280                "value_of_good": 570.48,
281                "price_marked": 1000,
282                "transfer_price": 0,
283                "brand_calculated_amount": 599,
284                "promotion_effective_discount": 0,
285                "coupon_value": 0,
286                "amount_to_be_collected": 0,
287                "pm_price_split": {
288                  "": 599
289                }
290              },
291              "item": {
292                "name": "FYND Black T-Shirt 03",
293                "brand": {
294                  "name": "lacoste",
295                  "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/JK1ZUAgrl-Logo.png"
296                },
297                "image": [
298                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/Cg5vRX38t-FYND-Black-Cotton-Mens-T-shirt.jpeg",
299                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QkYTI_VBn-FYND-Black-Cotton-Mens-T-shirt.jpeg",
300                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QRNIZFn7_-FYND-Black-T-Shirt.jpeg",
301                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
302                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
303                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg",
304                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
305                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
306                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg"
307                ],
308                "slug_key": "fynd-black-cotton-mens-t-shirt",
309                "size": "OS",
310                "code": "SHIRT-01",
311                "id": 7500429,
312                "category": {
313                  "l1": [
314                    {
315                      "uid": 124,
316                      "name": "Apparel",
317                      "level": 1,
318                      "departments": [
319                        {
320                          "uid": 24,
321                          "name": "Crafts Of India"
322                        },
323                        {
324                          "uid": 8,
325                          "name": "Fashion"
326                        }
327                      ],
328                      "gated_category_types": {}
329                    }
330                  ],
331                  "l2": [
332                    {
333                      "uid": 50,
334                      "name": "Western Wear",
335                      "level": 2,
336                      "departments": [
337                        {
338                          "uid": 8,
339                          "name": "Fashion"
340                        }
341                      ],
342                      "gated_category_types": {}
343                    }
344                  ],
345                  "l3": [
346                    {
347                      "uid": 25,
348                      "name": "T-Shirts",
349                      "level": 3,
350                      "departments": [
351                        {
352                          "uid": 1,
353                          "name": "Men's Fashionjhjh"
354                        },
355                        {
356                          "uid": 8,
357                          "name": "Fashion"
358                        }
359                      ],
360                      "gated_category_types": {
361                        "food": false
362                      }
363                    }
364                  ]
365                },
366                "seller_identifier": "SHIRT-01"
367              },
368              "financial_breakup": [
369                {
370                  "price_effective": 599,
371                  "discount": 401,
372                  "amount_paid": 599,
373                  "coupon_effective_discount": 0,
374                  "delivery_charge": 0,
375                  "fynd_credits": 0,
376                  "cod_charges": 0,
377                  "refund_credit": 0,
378                  "cashback": 0,
379                  "refund_amount": 599,
380                  "added_to_fynd_cash": false,
381                  "cashback_applied": 0,
382                  "gst_tax_percentage": 5,
383                  "value_of_good": 570.48,
384                  "price_marked": 1000,
385                  "transfer_price": 0,
386                  "brand_calculated_amount": 599,
387                  "promotion_effective_discount": 0,
388                  "coupon_value": 0,
389                  "amount_to_be_collected": 0,
390                  "pm_price_split": {
391                    "": 599
392                  },
393                  "size": "OS",
394                  "total_units": 1,
395                  "hsn_code": "62063000",
396                  "identifiers": {
397                    "sku_code": "SHIRT-01"
398                  },
399                  "item_name": "FYND Black T-Shirt 03",
400                  "gst_fee": 28.52,
401                  "gst_tag": "SGST"
402                }
403              ],
404              "quantity": 2,
405              "can_cancel": true,
406              "can_return": false,
407              "delivery_date": null,
408              "returnable_date": null,
409              "article": [
410                {
411                  "tags": [
412                    "1P"
413                  ]
414                }
415              ]
416            }
417          ],
418          "size_info": {
419            "SHIRT-01": {
420              "quantity": 2,
421              "price_effective": 599,
422              "amount_paid": 599,
423              "price_marked": 1000,
424              "margin": 40.1
425            }
426          },
427          "total_details": {
428            "sizes": 1,
429            "total_price": 599,
430            "pieces": 2
431          },
432          "fulfilling_store": {
433            "name": "Jio-market-store4",
434            "company_id": 33,
435            "id": 50,
436            "code": "store3"
437          },
438          "fulfilling_company": {
439            "id": 33,
440            "name": "RELIANCE JIO INFOCOMM LIMITED"
441          },
442          "delivery_date": null,
443          "delivery_address": {
444            "id": "62dfe1d112b842b2959de99e",
445            "uid": 660,
446            "area": "asd",
447            "city": "Mumbai",
448            "name": "Vaishakh Shetty",
449            "email": "test@example.com",
450            "phone": "8888888888",
451            "state": "Maharashtra",
452            "address": "dsa",
453            "country": "India",
454            "pincode": "400059",
455            "version": "1.0",
456            "address1": " asd",
457            "address2": "",
458            "landmark": "tr",
459            "latitude": 19.1157486,
460            "address_1": " asd",
461            "area_code": "400059",
462            "longitude": 72.8773159,
463            "created_at": "2022-09-22T18:19:29.000Z",
464            "updated_at": "2022-09-22T18:19:29.000Z",
465            "address_type": "home",
466            "country_code": "91",
467            "geo_location": {
468              "latitude": 19.1157486,
469              "longitude": 72.8773159
470            },
471            "area_code_slug": "pincode",
472            "delivery_address_id": 660,
473            "addressee_name": "Vaishakh Shetty",
474            "delivery_code_required": 1
475          },
476          "billing_address": {
477            "id": "62dfe1d112b842b2959de99e",
478            "uid": 660,
479            "area": "asd",
480            "city": "Mumbai",
481            "name": "Vaishakh Shetty",
482            "email": "test@example.com",
483            "phone": "8888888888",
484            "state": "Maharashtra",
485            "address": "dsa",
486            "country": "India",
487            "pincode": "400059",
488            "version": "1.0",
489            "address1": " asd",
490            "address2": "",
491            "landmark": "tr",
492            "latitude": 19.1157486,
493            "address_1": " asd",
494            "area_code": "400059",
495            "longitude": 72.8773159,
496            "created_at": "2022-09-22T18:19:29.000Z",
497            "updated_at": "2022-09-22T18:19:29.000Z",
498            "address_type": "home",
499            "country_code": "91",
500            "geo_location": {
501              "latitude": 19.1157486,
502              "longitude": 72.8773159
503            },
504            "area_code_slug": "pincode",
505            "delivery_address_id": 660,
506            "addressee_name": "Vaishakh Shetty",
507            "delivery_code_required": 1
508          },
509          "can_cancel": true,
510          "can_return": false,
511          "returnable_date": null,
512          "show_download_invoice": false,
513          "show_track_link": false,
514          "prices": {
515            "amount_paid": 1198,
516            "refund_amount": 1198,
517            "price_marked": 2000,
518            "cod_charges": 0,
519            "coupon_value": 0,
520            "discount": 802,
521            "cashback_applied": 0,
522            "delivery_charge": 0,
523            "fynd_credits": 0,
524            "cashback": 0,
525            "price_effective": 1198,
526            "refund_credit": 0,
527            "value_of_good": 1140.96,
528            "discount_percent": 40,
529            "amount_to_be_collected": 0
530          },
531          "can_break": {
532            "bag_repriced": {
533              "can_break_entity": false
534            },
535            "cancelled_seller": {
536              "can_break_entity": false
537            },
538            "bag_not_verified": {
539              "can_break_entity": false
540            },
541            "product_not_available": {
542              "can_break_entity": false
543            },
544            "bag_invoiced": {
545              "can_break_entity": false
546            },
547            "store_reassigned": {
548              "can_break_entity": false
549            },
550            "cancelled_fynd": {
551              "can_break_entity": false
552            },
553            "cancelled_operations": {
554              "can_break_entity": true
555            },
556            "cancelled_customer": {
557              "can_break_entity": true
558            },
559            "bag_not_confirmed": {
560              "can_break_entity": true
561            },
562            "delivery_sla_breached": {
563              "can_break_entity": false
564            },
565            "bag_confirmed": {
566              "can_break_entity": true
567            }
568          },
569          "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
570          "payment": {
571            "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
572            "mode": "Jio Partner Pay",
573            "mop": "PREPAID",
574            "status": "Paid"
575          },
576          "payment_info": [
577            {
578              "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
579              "mode": "Jio Partner Pay",
580              "mop": "PREPAID",
581              "status": "Paid"
582            }
583          ],
584          "user_info": {
585            "email": "test@example.com",
586            "gender": "male",
587            "mobile": "8888888888",
588            "name": "User -"
589          },
590          "comment": "",
591          "invoice": {
592            "updated_date": "1970-01-01T00:00:00.000Z",
593            "store_invoice_id": null,
594            "invoice_url": "",
595            "label_url": ""
596          },
597          "refund_details": {
598            "rrn": null
599          }
600        },
601        {
602          "order_id": "FY632D541F01152493D0",
603          "breakup_values": [
604            {
605              "name": "mrp_total",
606              "display": "MRP Total",
607              "value": 1000
608            },
609            {
610              "name": "sub_total",
611              "display": "Sub Total",
612              "value": 599
613            },
614            {
615              "name": "coupon",
616              "display": "Coupon",
617              "value": 0
618            },
619            {
620              "name": "discount",
621              "display": "Discount",
622              "value": -401
623            },
624            {
625              "name": "promotion",
626              "display": "Promotion",
627              "value": 0
628            },
629            {
630              "name": "reward_points",
631              "display": "Reward Points",
632              "value": 0
633            },
634            {
635              "name": "cashback_applied",
636              "display": "Cashback Applied",
637              "value": 0
638            },
639            {
640              "name": "delivery_charges",
641              "display": "Delivery Charges",
642              "value": 0
643            },
644            {
645              "name": "cod_charges",
646              "display": "COD Charges",
647              "value": 0
648            },
649            {
650              "name": "amount_to_be_collected",
651              "display": "Amount To Be Collected",
652              "value": 0
653            },
654            {
655              "name": "total",
656              "display": "Total",
657              "value": 599
658            }
659          ],
660          "beneficiary_details": false,
661          "shipment_created_at": "2022-09-23T12:07:58.000Z",
662          "shipment_id": "16639150772951172388K",
663          "shipment_status": {
664            "title": "Refund Initiated",
665            "value": "refund_initiated",
666            "hex_code": "#FE8F46"
667          },
668          "track_url": "",
669          "traking_no": "",
670          "awb_no": "",
671          "dp_name": "",
672          "tracking_details": [
673            {
674              "status": "Order Placed",
675              "time": "2022-09-23T12:07:35.000Z",
676              "is_passed": true,
677              "value": "processing"
678            },
679            {
680              "status": "Cancelled",
681              "time": "2022-09-23T12:07:57.000Z",
682              "is_passed": true,
683              "value": "cancelled"
684            },
685            {
686              "status": "Refund Processing",
687              "time": "2022-09-23T12:07:58.000Z",
688              "is_passed": true,
689              "value": "refund_initiated",
690              "tracking_details": [
691                {
692                  "status": "Refund Initiated",
693                  "time": "2022-09-23T12:07:58.000Z",
694                  "is_passed": true,
695                  "value": "refund_initiated"
696                },
697                {
698                  "status": "Refund Completed",
699                  "time": "",
700                  "is_passed": false,
701                  "value": "refund_done"
702                }
703              ]
704            }
705          ],
706          "total_bags": 1,
707          "order_type": null,
708          "promise": {
709            "show_promise": false,
710            "timestamp": {
711              "dp_promise": null,
712              "min": "2022-09-26T06:37:17.000Z",
713              "max": "2022-09-27T06:37:17.000Z"
714            }
715          },
716          "bags": [
717            {
718              "id": 67632,
719              "current_status": {
720                "status": "refund_acknowledged",
721                "updated_at": "2022-09-23T12:07:58.000Z",
722                "name": "Refund Acknowledged",
723                "journey_type": null
724              },
725              "prices": {
726                "price_effective": 599,
727                "discount": 401,
728                "amount_paid": 599,
729                "coupon_effective_discount": 0,
730                "delivery_charge": 0,
731                "fynd_credits": 0,
732                "cod_charges": 0,
733                "refund_credit": 0,
734                "cashback": 0,
735                "refund_amount": 599,
736                "added_to_fynd_cash": false,
737                "cashback_applied": 0,
738                "gst_tax_percentage": 5,
739                "value_of_good": 570.48,
740                "price_marked": 1000,
741                "transfer_price": 0,
742                "brand_calculated_amount": 599,
743                "promotion_effective_discount": 0,
744                "coupon_value": 0,
745                "amount_to_be_collected": 0,
746                "pm_price_split": {
747                  "": 599
748                }
749              },
750              "item": {
751                "name": "FYND Black T-Shirt 03",
752                "brand": {
753                  "name": "lacoste",
754                  "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/JK1ZUAgrl-Logo.png"
755                },
756                "image": [
757                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/Cg5vRX38t-FYND-Black-Cotton-Mens-T-shirt.jpeg",
758                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QkYTI_VBn-FYND-Black-Cotton-Mens-T-shirt.jpeg",
759                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QRNIZFn7_-FYND-Black-T-Shirt.jpeg",
760                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
761                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
762                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg",
763                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
764                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
765                  "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg"
766                ],
767                "slug_key": "fynd-black-cotton-mens-t-shirt",
768                "size": "OS",
769                "code": "SHIRT-01",
770                "id": 7500429,
771                "category": {
772                  "l1": [
773                    {
774                      "uid": 124,
775                      "name": "Apparel",
776                      "level": 1,
777                      "departments": [
778                        {
779                          "uid": 24,
780                          "name": "Crafts Of India"
781                        },
782                        {
783                          "uid": 8,
784                          "name": "Fashion"
785                        }
786                      ],
787                      "gated_category_types": {}
788                    }
789                  ],
790                  "l2": [
791                    {
792                      "uid": 50,
793                      "name": "Western Wear",
794                      "level": 2,
795                      "departments": [
796                        {
797                          "uid": 8,
798                          "name": "Fashion"
799                        }
800                      ],
801                      "gated_category_types": {}
802                    }
803                  ],
804                  "l3": [
805                    {
806                      "uid": 25,
807                      "name": "T-Shirts",
808                      "level": 3,
809                      "departments": [
810                        {
811                          "uid": 1,
812                          "name": "Men's Fashionjhjh"
813                        },
814                        {
815                          "uid": 8,
816                          "name": "Fashion"
817                        }
818                      ],
819                      "gated_category_types": {
820                        "food": false
821                      }
822                    }
823                  ]
824                },
825                "seller_identifier": "SHIRT-01"
826              },
827              "financial_breakup": [
828                {
829                  "price_effective": 599,
830                  "discount": 401,
831                  "amount_paid": 599,
832                  "coupon_effective_discount": 0,
833                  "delivery_charge": 0,
834                  "fynd_credits": 0,
835                  "cod_charges": 0,
836                  "refund_credit": 0,
837                  "cashback": 0,
838                  "refund_amount": 599,
839                  "added_to_fynd_cash": false,
840                  "cashback_applied": 0,
841                  "gst_tax_percentage": 5,
842                  "value_of_good": 570.48,
843                  "price_marked": 1000,
844                  "transfer_price": 0,
845                  "brand_calculated_amount": 599,
846                  "promotion_effective_discount": 0,
847                  "coupon_value": 0,
848                  "amount_to_be_collected": 0,
849                  "pm_price_split": {
850                    "": 599
851                  },
852                  "size": "OS",
853                  "total_units": 1,
854                  "hsn_code": "62063000",
855                  "identifiers": {
856                    "sku_code": "SHIRT-01"
857                  },
858                  "item_name": "FYND Black T-Shirt 03",
859                  "gst_fee": 28.52,
860                  "gst_tag": "SGST"
861                }
862              ],
863              "quantity": 1,
864              "can_cancel": false,
865              "can_return": false,
866              "delivery_date": null,
867              "returnable_date": null
868            }
869          ],
870          "size_info": {
871            "SHIRT-01": {
872              "quantity": 1,
873              "price_effective": 599,
874              "amount_paid": 599,
875              "price_marked": 1000,
876              "margin": 40.1
877            }
878          },
879          "total_details": {
880            "sizes": 1,
881            "total_price": 599,
882            "pieces": 1
883          },
884          "fulfilling_store": {
885            "name": "Jio-market-store4",
886            "company_id": 33,
887            "id": 50,
888            "code": "store3"
889          },
890          "fulfilling_company": {
891            "id": 33,
892            "name": "RELIANCE JIO INFOCOMM LIMITED"
893          },
894          "delivery_date": null,
895          "delivery_address": {
896            "id": "62dfe1d112b842b2959de99e",
897            "uid": 660,
898            "area": "asd",
899            "city": "Mumbai",
900            "name": "Vaishakh Shetty",
901            "email": "test@example.com",
902            "phone": "8888888888",
903            "state": "Maharashtra",
904            "address": "dsa",
905            "country": "India",
906            "pincode": "400059",
907            "version": "1.0",
908            "address1": " asd",
909            "address2": "",
910            "landmark": "tr",
911            "latitude": 19.1157486,
912            "address_1": " asd",
913            "area_code": "400059",
914            "longitude": 72.8773159,
915            "created_at": "2022-09-22T18:19:29.000Z",
916            "updated_at": "2022-09-22T18:19:29.000Z",
917            "address_type": "home",
918            "country_code": "91",
919            "geo_location": {
920              "latitude": 19.1157486,
921              "longitude": 72.8773159
922            },
923            "area_code_slug": "pincode",
924            "delivery_address_id": 660,
925            "addressee_name": "Vaishakh Shetty",
926            "delivery_code_required": 1
927          },
928          "can_cancel": false,
929          "can_return": false,
930          "returnable_date": null,
931          "show_download_invoice": false,
932          "show_track_link": false,
933          "prices": {
934            "amount_paid": 599,
935            "refund_amount": 599,
936            "price_marked": 1000,
937            "cod_charges": 0,
938            "coupon_value": 0,
939            "discount": 401,
940            "cashback_applied": 0,
941            "delivery_charge": 0,
942            "fynd_credits": 0,
943            "cashback": 0,
944            "price_effective": 599,
945            "refund_credit": 0,
946            "value_of_good": 570.48,
947            "discount_percent": 40,
948            "amount_to_be_collected": 0
949          },
950          "can_break": {
951            "refund_completed": {
952              "can_break_entity": false
953            },
954            "rto_delivery_attempt_failed": {
955              "can_break_entity": false
956            },
957            "return_rejected_by_dp": {
958              "can_break_entity": false
959            },
960            "return_to_origin": {
961              "can_break_entity": false
962            },
963            "rto_initiated": {
964              "can_break_entity": false
965            },
966            "refund_failed": {
967              "can_break_entity": false
968            },
969            "bag_picked": {
970              "can_break_entity": false
971            },
972            "rto_bag_delivered": {
973              "can_break_entity": false
974            },
975            "return_dp_assigned": {
976              "can_break_entity": false
977            },
978            "return_bag_in_transit": {
979              "can_break_entity": false
980            },
981            "return_bag_out_for_delivery": {
982              "can_break_entity": false
983            },
984            "return_initiated": {
985              "can_break_entity": true
986            },
987            "return_rejected_by_store": {
988              "can_break_entity": false
989            },
990            "rto_bag_out_for_delivery": {
991              "can_break_entity": false
992            },
993            "deadstock": {
994              "can_break_entity": false
995            },
996            "bag_lost": {
997              "can_break_entity": false
998            },
999            "return_bag_delivered": {
1000              "can_break_entity": false
1001            },
1002            "return_completed": {
1003              "can_break_entity": false
1004            },
1005            "return_bag_picked": {
1006              "can_break_entity": false
1007            },
1008            "rto_bag_accepted": {
1009              "can_break_entity": false
1010            },
1011            "deadstock_defective": {
1012              "can_break_entity": false
1013            },
1014            "rto_in_transit": {
1015              "can_break_entity": false
1016            },
1017            "return_accepted": {
1018              "can_break_entity": false
1019            },
1020            "out_for_pickup": {
1021              "can_break_entity": false
1022            },
1023            "return_bag_not_delivered": {
1024              "can_break_entity": false
1025            },
1026            "cancelled_customer": {
1027              "can_break_entity": true
1028            },
1029            "return_bag_lost": {
1030              "can_break_entity": false
1031            }
1032          },
1033          "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
1034          "payment": {
1035            "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
1036            "mode": "Jio Partner Pay",
1037            "mop": "PREPAID",
1038            "status": "Paid"
1039          },
1040          "payment_info": [
1041            {
1042              "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
1043              "mode": "Jio Partner Pay",
1044              "mop": "PREPAID",
1045              "status": "Paid"
1046            }
1047          ],
1048          "user_info": {
1049            "email": "test@example.com",
1050            "gender": "male",
1051            "mobile": "8888888888",
1052            "name": "User -"
1053          },
1054          "comment": "",
1055          "invoice": {
1056            "updated_date": "1970-01-01T00:00:00.000Z",
1057            "store_invoice_id": null,
1058            "invoice_url": "",
1059            "label_url": ""
1060          },
1061          "refund_details": {
1062            "rrn": ""
1063          }
1064        }
1065      ],
1066      "is_validated": false,
1067      "meta": {}
1068    }
1069  ],
1070  "page": {
1071    "type": "number",
1072    "size": 12,
1073    "current": 1,
1074    "has_next": false,
1075    "item_total": 10
1076  },
1077  "filters": {
1078    "statuses": [
1079      {
1080        "display": "All Status",
1081        "value": 1,
1082        "is_selected": true
1083      },
1084      {
1085        "display": "Delivered",
1086        "value": 2,
1087        "is_selected": false
1088      },
1089      {
1090        "display": "Cancelled",
1091        "value": 3,
1092        "is_selected": false
1093      },
1094      {
1095        "display": "Returned",
1096        "value": 4,
1097        "is_selected": false
1098      }
1099    ],
1100    "global": [
1101      {
1102        "display_test": "Status",
1103        "value": "status",
1104        "type": "single_select",
1105        "placeholder_text": "Select status",
1106        "required": false,
1107        "options": [
1108          {
1109            "display_text": "All",
1110            "value": "all",
1111            "is_selected": true
1112          },
1113          {
1114            "display_text": "Delivered",
1115            "value": "delivered",
1116            "is_selected": false
1117          },
1118          {
1119            "display_text": "Cancelled",
1120            "value": "cancelled",
1121            "is_selected": false
1122          },
1123          {
1124            "display_text": "Returned",
1125            "value": "returned",
1126            "is_selected": false
1127          }
1128        ]
1129      },
1130      {
1131        "display_test": "Time",
1132        "value": "time_range",
1133        "type": "single_select",
1134        "placeholder_text": "Select time",
1135        "required": false,
1136        "options": [
1137          {
1138            "display_text": "Last 30 days",
1139            "value": "last_30_days",
1140            "is_selected": false
1141          },
1142          {
1143            "display_text": "Last 3 months",
1144            "value": "last_3_months",
1145            "is_selected": false
1146          },
1147          {
1148            "display_text": "2024",
1149            "value": 2024,
1150            "is_selected": false
1151          },
1152          {
1153            "display_text": "2023",
1154            "value": 2023,
1155            "is_selected": false
1156          }
1157        ]
1158      }
1159    ]
1160  }
1161}

GET

Get an order

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.

Default Value : false

Response

200

Success.

OrderById

order

object (OrderSchema)

OrderSchema

total_shipments_in_order

integer

The total number of shipments in the order.

gstin_code

string

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.

string

Email address 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

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

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 (ShipmentPaymentInfo)

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 ShipmentPaymentInfo

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

Enum

gstin_code

string

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.

string

Email address of the user.

shipment_id

string

The unique identifier for the shipment.

fulfilling_store

object (FulfillingStore)

FulfillingStore

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

Schema for fulfilling store.

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

comment

string

Any comments related to the shipment.

invoice

object (Invoice)

Invoice

invoice_url

string

URL providing access to the invoice.

updated_date

string

| date-time

The date and time when the invoice was last updated.

label_url

string

URL providing access to the invoice label.

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

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.

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.

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

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

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.

number

The unique identifier of the item.

name

string

The name of the item.

l3_category_name

string

This key specifies the name of the third-level category under which the product is listed, offering a more detailed classification within the e-commerce platform's hierarchy.

slug_key

string

A unique key or identifier for the item slug.

l2_categories

array of string

An array of level 2 categories the item belongs to.

size

string

The size of the item.

attributes

object

An object containing various attributes of the item.

applied_promos

array of object (AppliedPromos)

An array containing information about applied promotions.

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

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

integer

The quantity of the item.

prices

object (Prices)

Prices

delivery_charge

number

The delivery charge for the order.

coupon_value

number

The value of the coupon applied.

brand_calculated_amount

number

The amount calculated by the brand.

value_of_good

number

The value of the goods before tax and other charges.

price_marked

number

The original marked price of the item.

coupon_effective_discount

number

The effective discount from coupons.

currency_symbol

string

The symbol of the currency used.

discount

number

The discount applied to the item.

gst_tax_percentage

number

The GST tax percentage applied.

cod_charges

number

The cash on delivery charges, if applicable.

amount_paid

number

The total amount paid by the customer.

added_to_fynd_cash

boolean

Indicates if the refund amount was added to Fynd Cash.

transfer_price

number

The transfer price of the item.

cashback_applied

number

The amount of cashback applied.

price_effective

number

The effective price after all adjustments.

cashback

number

The cashback amount earned.

refund_credit

number

The amount credited for refund .

amount_paid_roundoff

number

The rounded-off amount paid by the customer.

promotion_effective_discount

number

The effective discount from promotions.

refund_amount

number

The amount refunded to the customer.

currency_code

string

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.

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

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

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

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

Enum

article

object (Article)

Nullable

Article

tags

array of string

An array of tags associated with the article.

charges

array of object (PriceAdjustmentCharge)

An array of charges associated with the order item.

Array of PriceAdjustmentCharge

code

string

Nullable

Code defined for charge

name

string

Display name for charge (charge is unique by the name)

type

string

Nullable

Type defined for charge

amount

object (ChargeAmount)

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

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

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

Enum

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

Enum

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.

charges

array of object (PriceAdjustmentCharge)

An array of charge objects associated with the shipment.

Array of PriceAdjustmentCharge

code

string

Nullable

Code defined for charge

name

string

Display name for charge (charge is unique by the name)

type

string

Nullable

Type defined for charge

amount

object (ChargeAmount)

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

bags_for_reorder

array of object (BagsForReorder)

Items to be added to the cart when reordering a previous purchase.

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

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

meta

object

An object containing additional metadata for the order.

currency

object (CurrencySchema)

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.

Examples

Parameters

order_id:

"value"

allow_inactive:

false

Was this section helpful?

GET

/service/application/order/v1.0/orders/{order_id}

1curl -X GET "https://api.fynd.com/service/application/order/v1.0/orders/{order_id}" 
2 -H 'Authorization: Bearer {authorization_token}'

Try it

Response

1{
2  "order": {
3    "bags_for_reorder": [
4      {
5        "item_id": 7500429,
6        "item_size": "OS",
7        "store_id": 50,
8        "seller_id": 33,
9        "article_assignment": {
10          "level": "multi-companies",
11          "strategy": "low-price"
12        },
13        "quantity": 3
14      }
15    ],
16    "gstin_code": "27AALCA0442L1ZM",
17    "user_info": {
18      "mobile": "8888888888",
19      "first_name": "User",
20      "last_name": "-",
21      "gender": "male"
22    },
23    "order_created_time": "2022-09-23T12:07:20.000Z",
24    "total_shipments_in_order": 2,
25    "order_id": "FY632D541F01152493D0",
26    "charges": [],
27    "breakup_values": [
28      {
29        "name": "mrp_total",
30        "display": "MRP Total",
31        "value": 3000
32      },
33      {
34        "name": "sub_total",
35        "display": "Sub Total",
36        "value": 1797
37      },
38      {
39        "name": "coupon",
40        "display": "Coupon",
41        "value": 0
42      },
43      {
44        "name": "discount",
45        "display": "Discount",
46        "value": -1203
47      },
48      {
49        "name": "promotion",
50        "display": "Promotion",
51        "value": 0
52      },
53      {
54        "name": "reward_points",
55        "display": "Reward Points",
56        "value": 0
57      },
58      {
59        "name": "cashback_applied",
60        "display": "Cashback Applied",
61        "value": 0
62      },
63      {
64        "name": "delivery_charges",
65        "display": "Delivery Charges",
66        "value": 0
67      },
68      {
69        "name": "cod_charges",
70        "display": "COD Charges",
71        "value": 0
72      },
73      {
74        "name": "amount_to_be_collected",
75        "display": "Amount To Be Collected",
76        "value": 0
77      },
78      {
79        "name": "Delivery Charge 2",
80        "display": "Delivery Charge 2",
81        "value": 100
82      },
83      {
84        "name": "total",
85        "display": "Total",
86        "value": 1897
87      }
88    ],
89    "shipments": [
90      {
91        "order_id": "FY632D541F01152493D0",
92        "order": {
93          "meta": {
94            "custom_cart_id": "652ce6972512f05477a32547",
95            "name": "Universal/Smart Bazar/Fresh Cart",
96            "slug": "universal/smart-bazar/fresh-cart"
97          },
98          "charges": [
99            {
100              "code": "Delivery Charge 2",
101              "name": "Delivery Charge 2",
102              "type": "charge",
103              "amount": {
104                "base_currency": {
105                  "value": 100,
106                  "currency": "INR"
107                },
108                "ordering_currency": {
109                  "value": 100,
110                  "currency": "INR"
111                }
112              },
113              "distribution_logic": {
114                "distribution": {
115                  "rule": {
116                    "conditions": {
117                      "department": [
118                        "elect",
119                        "groceries"
120                      ],
121                      "article_tag": "1p"
122                    }
123                  },
124                  "type": "multi",
125                  "logic": "apportion"
126                },
127                "distribution_level": "shipment"
128              }
129            }
130          ]
131        },
132        "breakup_values": [
133          {
134            "name": "mrp_total",
135            "display": "MRP Total",
136            "value": 2000
137          },
138          {
139            "name": "sub_total",
140            "display": "Sub Total",
141            "value": 1198
142          },
143          {
144            "name": "coupon",
145            "display": "Coupon",
146            "value": 0
147          },
148          {
149            "name": "discount",
150            "display": "Discount",
151            "value": -802
152          },
153          {
154            "name": "promotion",
155            "display": "Promotion",
156            "value": 0
157          },
158          {
159            "name": "reward_points",
160            "display": "Reward Points",
161            "value": 0
162          },
163          {
164            "name": "cashback_applied",
165            "display": "Cashback Applied",
166            "value": 0
167          },
168          {
169            "name": "delivery_charges",
170            "display": "Delivery Charges",
171            "value": 0
172          },
173          {
174            "name": "cod_charges",
175            "display": "COD Charges",
176            "value": 0
177          },
178          {
179            "name": "amount_to_be_collected",
180            "display": "Amount To Be Collected",
181            "value": 0
182          },
183          {
184            "name": "Delivery Charge 2",
185            "display": "Delivery Charge 2",
186            "value": 100
187          },
188          {
189            "name": "total",
190            "display": "Total",
191            "value": 1298
192          }
193        ],
194        "beneficiary_details": false,
195        "shipment_created_at": "2022-09-23T12:07:35.000Z",
196        "shipment_id": "16639150404761166748K",
197        "shipment_status": {
198          "title": "Placed",
199          "value": "processing",
200          "hex_code": "#02D1CB"
201        },
202        "track_url": "",
203        "traking_no": "",
204        "awb_no": "",
205        "dp_name": "",
206        "tracking_details": [
207          {
208            "status": "Order Placed",
209            "time": "2022-09-23T12:07:35.000Z",
210            "is_passed": true,
211            "value": "processing"
212          },
213          {
214            "status": "Order Confirmed",
215            "time": "",
216            "is_passed": false,
217            "value": "confirmed"
218          },
219          {
220            "status": "Delivery Partner Assigned",
221            "time": "",
222            "is_passed": false,
223            "value": "dp_assigned"
224          },
225          {
226            "status": "In Transit",
227            "time": "",
228            "is_passed": false,
229            "value": "in_transit"
230          },
231          {
232            "status": "Out For Delivery",
233            "time": "",
234            "is_passed": false,
235            "value": "out_for_delivery"
236          },
237          {
238            "status": "Delivered",
239            "time": "",
240            "is_passed": false,
241            "value": "delivered"
242          }
243        ],
244        "total_bags": 1,
245        "order_type": "HomeDelivery",
246        "promise": {
247          "show_promise": true,
248          "timestamp": {
249            "dp_promise": null,
250            "min": "2022-09-26T06:37:17.000Z",
251            "max": "2022-09-27T06:37:17.000Z"
252          }
253        },
254        "bags": [
255          {
256            "id": 67631,
257            "current_status": {
258              "status": "placed",
259              "updated_at": "2022-09-23T12:07:35.000Z",
260              "name": "Placed",
261              "journey_type": "forward"
262            },
263            "charges": [],
264            "prices": {
265              "price_effective": 599,
266              "discount": 401,
267              "amount_paid": 599,
268              "coupon_effective_discount": 0,
269              "delivery_charge": 0,
270              "fynd_credits": 0,
271              "cod_charges": 0,
272              "refund_credit": 0,
273              "cashback": 0,
274              "refund_amount": 599,
275              "added_to_fynd_cash": false,
276              "cashback_applied": 0,
277              "gst_tax_percentage": 5,
278              "value_of_good": 570.48,
279              "price_marked": 1000,
280              "transfer_price": 0,
281              "brand_calculated_amount": 599,
282              "promotion_effective_discount": 0,
283              "coupon_value": 0,
284              "amount_to_be_collected": 0,
285              "pm_price_split": {
286                "": 599
287              }
288            },
289            "item": {
290              "name": "FYND Black T-Shirt 03",
291              "brand": {
292                "name": "lacoste",
293                "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/JK1ZUAgrl-Logo.png"
294              },
295              "image": [
296                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/Cg5vRX38t-FYND-Black-Cotton-Mens-T-shirt.jpeg",
297                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QkYTI_VBn-FYND-Black-Cotton-Mens-T-shirt.jpeg",
298                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QRNIZFn7_-FYND-Black-T-Shirt.jpeg",
299                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
300                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
301                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg",
302                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
303                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
304                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg"
305              ],
306              "slug_key": "fynd-black-cotton-mens-t-shirt",
307              "size": "OS",
308              "code": "SHIRT-01",
309              "id": 7500429,
310              "category": {
311                "l1": [
312                  {
313                    "uid": 124,
314                    "name": "Apparel",
315                    "level": 1,
316                    "departments": [
317                      {
318                        "uid": 24,
319                        "name": "Crafts Of India"
320                      },
321                      {
322                        "uid": 8,
323                        "name": "Fashion"
324                      }
325                    ],
326                    "gated_category_types": {}
327                  }
328                ],
329                "l2": [
330                  {
331                    "uid": 50,
332                    "name": "Western Wear",
333                    "level": 2,
334                    "departments": [
335                      {
336                        "uid": 8,
337                        "name": "Fashion"
338                      }
339                    ],
340                    "gated_category_types": {}
341                  }
342                ],
343                "l3": [
344                  {
345                    "uid": 25,
346                    "name": "T-Shirts",
347                    "level": 3,
348                    "departments": [
349                      {
350                        "uid": 1,
351                        "name": "Men's Fashionjhjh"
352                      },
353                      {
354                        "uid": 8,
355                        "name": "Fashion"
356                      }
357                    ],
358                    "gated_category_types": {
359                      "food": false
360                    }
361                  }
362                ]
363              },
364              "seller_identifier": "SHIRT-01"
365            },
366            "financial_breakup": [
367              {
368                "price_effective": 599,
369                "discount": 401,
370                "amount_paid": 599,
371                "coupon_effective_discount": 0,
372                "delivery_charge": 0,
373                "fynd_credits": 0,
374                "cod_charges": 0,
375                "refund_credit": 0,
376                "cashback": 0,
377                "refund_amount": 599,
378                "added_to_fynd_cash": false,
379                "cashback_applied": 0,
380                "gst_tax_percentage": 5,
381                "value_of_good": 570.48,
382                "price_marked": 1000,
383                "transfer_price": 0,
384                "brand_calculated_amount": 599,
385                "promotion_effective_discount": 0,
386                "coupon_value": 0,
387                "amount_to_be_collected": 0,
388                "pm_price_split": {
389                  "": 599
390                },
391                "size": "OS",
392                "total_units": 1,
393                "hsn_code": "62063000",
394                "identifiers": {
395                  "sku_code": "SHIRT-01"
396                },
397                "item_name": "FYND Black T-Shirt 03",
398                "gst_fee": 28.52,
399                "gst_tag": "SGST"
400              }
401            ],
402            "quantity": 2,
403            "can_cancel": true,
404            "can_return": false,
405            "delivery_date": null,
406            "returnable_date": null,
407            "article": {
408              "tags": [
409                "1P"
410              ]
411            }
412          }
413        ],
414        "size_info": {
415          "SHIRT-01": {
416            "quantity": 2,
417            "price_effective": 599,
418            "amount_paid": 599,
419            "price_marked": 1000,
420            "margin": 40.1
421          }
422        },
423        "total_details": {
424          "sizes": 1,
425          "total_price": 599,
426          "pieces": 2
427        },
428        "fulfilling_store": {
429          "name": "Jio-market-store4",
430          "company_id": 33,
431          "id": 50,
432          "code": "store3"
433        },
434        "fulfilling_company": {
435          "id": 33,
436          "name": "RELIANCE JIO INFOCOMM LIMITED"
437        },
438        "delivery_date": null,
439        "delivery_address": {
440          "id": "62dfe1d112b842b2959de99e",
441          "uid": 660,
442          "area": "asd",
443          "city": "Mumbai",
444          "name": "Vaishakh Shetty",
445          "email": "test@example.com",
446          "phone": "8888888888",
447          "state": "Maharashtra",
448          "address": "dsa",
449          "country": "India",
450          "pincode": "400059",
451          "version": "1.0",
452          "address1": " asd",
453          "address2": "",
454          "landmark": "tr",
455          "latitude": 19.1157486,
456          "address_1": " asd",
457          "area_code": "400059",
458          "longitude": 72.8773159,
459          "created_at": "2022-09-22T18:19:29.000Z",
460          "updated_at": "2022-09-22T18:19:29.000Z",
461          "address_type": "home",
462          "country_code": "91",
463          "geo_location": {
464            "latitude": 19.1157486,
465            "longitude": 72.8773159
466          },
467          "area_code_slug": "pincode",
468          "delivery_address_id": 660,
469          "addressee_name": "Vaishakh Shetty",
470          "delivery_code_required": 1
471        },
472        "billing_address": {
473          "id": "62dfe1d112b842b2959de99e",
474          "uid": 660,
475          "area": "asd",
476          "city": "Mumbai",
477          "name": "Vaishakh Shetty",
478          "email": "test@example.com",
479          "phone": "8888888888",
480          "state": "Maharashtra",
481          "address": "dsa",
482          "country": "India",
483          "pincode": "400059",
484          "version": "1.0",
485          "address1": " asd",
486          "address2": "",
487          "landmark": "tr",
488          "latitude": 19.1157486,
489          "address_1": " asd",
490          "area_code": "400059",
491          "longitude": 72.8773159,
492          "created_at": "2022-09-22T18:19:29.000Z",
493          "updated_at": "2022-09-22T18:19:29.000Z",
494          "address_type": "home",
495          "country_code": "91",
496          "geo_location": {
497            "latitude": 19.1157486,
498            "longitude": 72.8773159
499          },
500          "area_code_slug": "pincode",
501          "delivery_address_id": 660,
502          "addressee_name": "Vaishakh Shetty",
503          "delivery_code_required": 1
504        },
505        "can_cancel": true,
506        "can_return": false,
507        "returnable_date": null,
508        "show_download_invoice": false,
509        "show_track_link": false,
510        "prices": {
511          "amount_paid": 1198,
512          "refund_amount": 1198,
513          "price_marked": 2000,
514          "cod_charges": 0,
515          "coupon_value": 0,
516          "discount": 802,
517          "cashback_applied": 0,
518          "delivery_charge": 0,
519          "fynd_credits": 0,
520          "cashback": 0,
521          "price_effective": 1198,
522          "refund_credit": 0,
523          "value_of_good": 1140.96,
524          "discount_percent": 40,
525          "amount_to_be_collected": 0
526        },
527        "can_break": {
528          "bag_repriced": {
529            "can_break_entity": false
530          },
531          "cancelled_seller": {
532            "can_break_entity": false
533          },
534          "bag_not_verified": {
535            "can_break_entity": false
536          },
537          "product_not_available": {
538            "can_break_entity": false
539          },
540          "bag_invoiced": {
541            "can_break_entity": false
542          },
543          "store_reassigned": {
544            "can_break_entity": false
545          },
546          "cancelled_fynd": {
547            "can_break_entity": false
548          },
549          "cancelled_operations": {
550            "can_break_entity": true
551          },
552          "cancelled_customer": {
553            "can_break_entity": true
554          },
555          "bag_not_confirmed": {
556            "can_break_entity": true
557          },
558          "delivery_sla_breached": {
559            "can_break_entity": false
560          },
561          "bag_confirmed": {
562            "can_break_entity": true
563          }
564        },
565        "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
566        "payment": {
567          "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
568          "mode": "Jio Partner Pay",
569          "mop": "PREPAID",
570          "status": "Paid"
571        },
572        "payment_info": [
573          {
574            "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
575            "mode": "Jio Partner Pay",
576            "mop": "PREPAID",
577            "status": "Paid"
578          }
579        ],
580        "user_info": {
581          "email": "test@example.com",
582          "gender": "male",
583          "mobile": "8888888888",
584          "name": "User -"
585        },
586        "comment": "",
587        "invoice": {
588          "updated_date": "1970-01-01T00:00:00.000Z",
589          "store_invoice_id": null,
590          "invoice_url": "",
591          "label_url": ""
592        },
593        "refund_details": {
594          "rrn": null
595        }
596      },
597      {
598        "order_id": "FY632D541F01152493D0",
599        "breakup_values": [
600          {
601            "name": "mrp_total",
602            "display": "MRP Total",
603            "value": 1000
604          },
605          {
606            "name": "sub_total",
607            "display": "Sub Total",
608            "value": 599
609          },
610          {
611            "name": "coupon",
612            "display": "Coupon",
613            "value": 0
614          },
615          {
616            "name": "discount",
617            "display": "Discount",
618            "value": -401
619          },
620          {
621            "name": "promotion",
622            "display": "Promotion",
623            "value": 0
624          },
625          {
626            "name": "reward_points",
627            "display": "Reward Points",
628            "value": 0
629          },
630          {
631            "name": "cashback_applied",
632            "display": "Cashback Applied",
633            "value": 0
634          },
635          {
636            "name": "delivery_charges",
637            "display": "Delivery Charges",
638            "value": 0
639          },
640          {
641            "name": "cod_charges",
642            "display": "COD Charges",
643            "value": 0
644          },
645          {
646            "name": "amount_to_be_collected",
647            "display": "Amount To Be Collected",
648            "value": 0
649          },
650          {
651            "name": "total",
652            "display": "Total",
653            "value": 599
654          }
655        ],
656        "beneficiary_details": false,
657        "shipment_created_at": "2022-09-23T12:07:58.000Z",
658        "shipment_id": "16639150772951172388K",
659        "shipment_status": {
660          "title": "Refund Initiated",
661          "value": "refund_initiated",
662          "hex_code": "#FE8F46"
663        },
664        "track_url": "",
665        "traking_no": "",
666        "awb_no": "",
667        "dp_name": "",
668        "tracking_details": [
669          {
670            "status": "Order Placed",
671            "time": "2022-09-23T12:07:35.000Z",
672            "is_passed": true,
673            "value": "processing"
674          },
675          {
676            "status": "Cancelled",
677            "time": "2022-09-23T12:07:57.000Z",
678            "is_passed": true,
679            "value": "cancelled"
680          },
681          {
682            "status": "Refund Processing",
683            "time": "2022-09-23T12:07:58.000Z",
684            "is_passed": true,
685            "value": "refund_initiated",
686            "tracking_details": [
687              {
688                "status": "Refund Initiated",
689                "time": "2022-09-23T12:07:58.000Z",
690                "is_passed": true,
691                "value": "refund_initiated"
692              },
693              {
694                "status": "Refund Completed",
695                "time": "",
696                "is_passed": false,
697                "value": "refund_done"
698              }
699            ]
700          }
701        ],
702        "total_bags": 1,
703        "order_type": null,
704        "promise": {
705          "show_promise": false,
706          "timestamp": {
707            "dp_promise": null,
708            "min": "2022-09-26T06:37:17.000Z",
709            "max": "2022-09-27T06:37:17.000Z"
710          }
711        },
712        "bags": [
713          {
714            "id": 67632,
715            "current_status": {
716              "status": "refund_acknowledged",
717              "updated_at": "2022-09-23T12:07:58.000Z",
718              "name": "Refund Acknowledged",
719              "journey_type": null
720            },
721            "prices": {
722              "price_effective": 599,
723              "discount": 401,
724              "amount_paid": 599,
725              "coupon_effective_discount": 0,
726              "delivery_charge": 0,
727              "fynd_credits": 0,
728              "cod_charges": 0,
729              "refund_credit": 0,
730              "cashback": 0,
731              "refund_amount": 599,
732              "added_to_fynd_cash": false,
733              "cashback_applied": 0,
734              "gst_tax_percentage": 5,
735              "value_of_good": 570.48,
736              "price_marked": 1000,
737              "transfer_price": 0,
738              "brand_calculated_amount": 599,
739              "promotion_effective_discount": 0,
740              "coupon_value": 0,
741              "amount_to_be_collected": 0,
742              "pm_price_split": {
743                "": 599
744              }
745            },
746            "item": {
747              "name": "FYND Black T-Shirt 03",
748              "brand": {
749                "name": "lacoste",
750                "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/JK1ZUAgrl-Logo.png"
751              },
752              "image": [
753                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/Cg5vRX38t-FYND-Black-Cotton-Mens-T-shirt.jpeg",
754                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QkYTI_VBn-FYND-Black-Cotton-Mens-T-shirt.jpeg",
755                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QRNIZFn7_-FYND-Black-T-Shirt.jpeg",
756                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
757                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
758                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg",
759                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
760                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
761                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg"
762              ],
763              "slug_key": "fynd-black-cotton-mens-t-shirt",
764              "size": "OS",
765              "code": "SHIRT-01",
766              "id": 7500429,
767              "category": {
768                "l1": [
769                  {
770                    "uid": 124,
771                    "name": "Apparel",
772                    "level": 1,
773                    "departments": [
774                      {
775                        "uid": 24,
776                        "name": "Crafts Of India"
777                      },
778                      {
779                        "uid": 8,
780                        "name": "Fashion"
781                      }
782                    ],
783                    "gated_category_types": {}
784                  }
785                ],
786                "l2": [
787                  {
788                    "uid": 50,
789                    "name": "Western Wear",
790                    "level": 2,
791                    "departments": [
792                      {
793                        "uid": 8,
794                        "name": "Fashion"
795                      }
796                    ],
797                    "gated_category_types": {}
798                  }
799                ],
800                "l3": [
801                  {
802                    "uid": 25,
803                    "name": "T-Shirts",
804                    "level": 3,
805                    "departments": [
806                      {
807                        "uid": 1,
808                        "name": "Men's Fashionjhjh"
809                      },
810                      {
811                        "uid": 8,
812                        "name": "Fashion"
813                      }
814                    ],
815                    "gated_category_types": {
816                      "food": false
817                    }
818                  }
819                ]
820              },
821              "seller_identifier": "SHIRT-01"
822            },
823            "financial_breakup": [
824              {
825                "price_effective": 599,
826                "discount": 401,
827                "amount_paid": 599,
828                "coupon_effective_discount": 0,
829                "delivery_charge": 0,
830                "fynd_credits": 0,
831                "cod_charges": 0,
832                "refund_credit": 0,
833                "cashback": 0,
834                "refund_amount": 599,
835                "added_to_fynd_cash": false,
836                "cashback_applied": 0,
837                "gst_tax_percentage": 5,
838                "value_of_good": 570.48,
839                "price_marked": 1000,
840                "transfer_price": 0,
841                "brand_calculated_amount": 599,
842                "promotion_effective_discount": 0,
843                "coupon_value": 0,
844                "amount_to_be_collected": 0,
845                "pm_price_split": {
846                  "": 599
847                },
848                "size": "OS",
849                "total_units": 1,
850                "hsn_code": "62063000",
851                "identifiers": {
852                  "sku_code": "SHIRT-01"
853                },
854                "item_name": "FYND Black T-Shirt 03",
855                "gst_fee": 28.52,
856                "gst_tag": "SGST"
857              }
858            ],
859            "quantity": 1,
860            "can_cancel": false,
861            "can_return": false,
862            "delivery_date": null,
863            "returnable_date": null
864          }
865        ],
866        "size_info": {
867          "SHIRT-01": {
868            "quantity": 1,
869            "price_effective": 599,
870            "amount_paid": 599,
871            "price_marked": 1000,
872            "margin": 40.1
873          }
874        },
875        "total_details": {
876          "sizes": 1,
877          "total_price": 599,
878          "pieces": 1
879        },
880        "fulfilling_store": {
881          "name": "Jio-market-store4",
882          "company_id": 33,
883          "id": 50,
884          "code": "store3"
885        },
886        "fulfilling_company": {
887          "id": 33,
888          "name": "RELIANCE JIO INFOCOMM LIMITED"
889        },
890        "delivery_date": null,
891        "delivery_address": {
892          "id": "62dfe1d112b842b2959de99e",
893          "uid": 660,
894          "area": "asd",
895          "city": "Mumbai",
896          "name": "Vaishakh Shetty",
897          "email": "test@example.com",
898          "phone": "8888888888",
899          "state": "Maharashtra",
900          "address": "dsa",
901          "country": "India",
902          "pincode": "400059",
903          "version": "1.0",
904          "address1": " asd",
905          "address2": "",
906          "landmark": "tr",
907          "latitude": 19.1157486,
908          "address_1": " asd",
909          "area_code": "400059",
910          "longitude": 72.8773159,
911          "created_at": "2022-09-22T18:19:29.000Z",
912          "updated_at": "2022-09-22T18:19:29.000Z",
913          "address_type": "home",
914          "country_code": "91",
915          "geo_location": {
916            "latitude": 19.1157486,
917            "longitude": 72.8773159
918          },
919          "area_code_slug": "pincode",
920          "delivery_address_id": 660,
921          "addressee_name": "Vaishakh Shetty",
922          "delivery_code_required": 1
923        },
924        "can_cancel": false,
925        "can_return": false,
926        "returnable_date": null,
927        "show_download_invoice": false,
928        "show_track_link": false,
929        "prices": {
930          "amount_paid": 599,
931          "refund_amount": 599,
932          "price_marked": 1000,
933          "cod_charges": 0,
934          "coupon_value": 0,
935          "discount": 401,
936          "cashback_applied": 0,
937          "delivery_charge": 0,
938          "fynd_credits": 0,
939          "cashback": 0,
940          "price_effective": 599,
941          "refund_credit": 0,
942          "value_of_good": 570.48,
943          "discount_percent": 40,
944          "amount_to_be_collected": 0
945        },
946        "can_break": {
947          "refund_completed": {
948            "can_break_entity": false
949          },
950          "rto_delivery_attempt_failed": {
951            "can_break_entity": false
952          },
953          "return_rejected_by_dp": {
954            "can_break_entity": false
955          },
956          "return_to_origin": {
957            "can_break_entity": false
958          },
959          "rto_initiated": {
960            "can_break_entity": false
961          },
962          "refund_failed": {
963            "can_break_entity": false
964          },
965          "bag_picked": {
966            "can_break_entity": false
967          },
968          "rto_bag_delivered": {
969            "can_break_entity": false
970          },
971          "return_dp_assigned": {
972            "can_break_entity": false
973          },
974          "return_bag_in_transit": {
975            "can_break_entity": false
976          },
977          "return_bag_out_for_delivery": {
978            "can_break_entity": false
979          },
980          "return_initiated": {
981            "can_break_entity": true
982          },
983          "return_rejected_by_store": {
984            "can_break_entity": false
985          },
986          "rto_bag_out_for_delivery": {
987            "can_break_entity": false
988          },
989          "deadstock": {
990            "can_break_entity": false
991          },
992          "bag_lost": {
993            "can_break_entity": false
994          },
995          "return_bag_delivered": {
996            "can_break_entity": false
997          },
998          "return_completed": {
999            "can_break_entity": false
1000          },
1001          "return_bag_picked": {
1002            "can_break_entity": false
1003          },
1004          "rto_bag_accepted": {
1005            "can_break_entity": false
1006          },
1007          "deadstock_defective": {
1008            "can_break_entity": false
1009          },
1010          "rto_in_transit": {
1011            "can_break_entity": false
1012          },
1013          "return_accepted": {
1014            "can_break_entity": false
1015          },
1016          "out_for_pickup": {
1017            "can_break_entity": false
1018          },
1019          "return_bag_not_delivered": {
1020            "can_break_entity": false
1021          },
1022          "cancelled_customer": {
1023            "can_break_entity": true
1024          },
1025          "return_bag_lost": {
1026            "can_break_entity": false
1027          }
1028        },
1029        "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
1030        "payment": {
1031          "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
1032          "mode": "Jio Partner Pay",
1033          "mop": "PREPAID",
1034          "status": "Paid"
1035        },
1036        "payment_info": [
1037          {
1038            "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
1039            "mode": "Jio Partner Pay",
1040            "mop": "PREPAID",
1041            "status": "Paid"
1042          }
1043        ],
1044        "user_info": {
1045          "email": "test@example.com",
1046          "gender": "male",
1047          "mobile": "8888888888",
1048          "name": "User -"
1049        },
1050        "comment": "",
1051        "invoice": {
1052          "updated_date": "1970-01-01T00:00:00.000Z",
1053          "store_invoice_id": null,
1054          "invoice_url": "",
1055          "label_url": ""
1056        },
1057        "refund_details": {
1058          "rrn": ""
1059        }
1060      }
1061    ],
1062    "is_validated": false,
1063    "meta": {}
1064  }
1065}

GET

Retrieves POS order details

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

Success.

OrderById

order

object (OrderSchema)

OrderSchema

total_shipments_in_order

integer

The total number of shipments in the order.

gstin_code

string

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.

string

Email address 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

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

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 (ShipmentPaymentInfo)

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 ShipmentPaymentInfo

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

Enum

gstin_code

string

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.

string

Email address of the user.

shipment_id

string

The unique identifier for the shipment.

fulfilling_store

object (FulfillingStore)

FulfillingStore

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

Schema for fulfilling store.

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

comment

string

Any comments related to the shipment.

invoice

object (Invoice)

Invoice

invoice_url

string

URL providing access to the invoice.

updated_date

string

| date-time

The date and time when the invoice was last updated.

label_url

string

URL providing access to the invoice label.

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

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.

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.

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

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

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.

number

The unique identifier of the item.

name

string

The name of the item.

l3_category_name

string

This key specifies the name of the third-level category under which the product is listed, offering a more detailed classification within the e-commerce platform's hierarchy.

slug_key

string

A unique key or identifier for the item slug.

l2_categories

array of string

An array of level 2 categories the item belongs to.

size

string

The size of the item.

attributes

object

An object containing various attributes of the item.

applied_promos

array of object (AppliedPromos)

An array containing information about applied promotions.

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

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

integer

The quantity of the item.

prices

object (Prices)

Prices

delivery_charge

number

The delivery charge for the order.

coupon_value

number

The value of the coupon applied.

brand_calculated_amount

number

The amount calculated by the brand.

value_of_good

number

The value of the goods before tax and other charges.

price_marked

number

The original marked price of the item.

coupon_effective_discount

number

The effective discount from coupons.

currency_symbol

string

The symbol of the currency used.

discount

number

The discount applied to the item.

gst_tax_percentage

number

The GST tax percentage applied.

cod_charges

number

The cash on delivery charges, if applicable.

amount_paid

number

The total amount paid by the customer.

added_to_fynd_cash

boolean

Indicates if the refund amount was added to Fynd Cash.

transfer_price

number

The transfer price of the item.

cashback_applied

number

The amount of cashback applied.

price_effective

number

The effective price after all adjustments.

cashback

number

The cashback amount earned.

refund_credit

number

The amount credited for refund .

amount_paid_roundoff

number

The rounded-off amount paid by the customer.

promotion_effective_discount

number

The effective discount from promotions.

refund_amount

number

The amount refunded to the customer.

currency_code

string

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.

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

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

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

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

Enum

article

object (Article)

Nullable

Article

tags

array of string

An array of tags associated with the article.

charges

array of object (PriceAdjustmentCharge)

An array of charges associated with the order item.

Array of PriceAdjustmentCharge

code

string

Nullable

Code defined for charge

name

string

Display name for charge (charge is unique by the name)

type

string

Nullable

Type defined for charge

amount

object (ChargeAmount)

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

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

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

Enum

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

Enum

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.

charges

array of object (PriceAdjustmentCharge)

An array of charge objects associated with the shipment.

Array of PriceAdjustmentCharge

code

string

Nullable

Code defined for charge

name

string

Display name for charge (charge is unique by the name)

type

string

Nullable

Type defined for charge

amount

object (ChargeAmount)

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

bags_for_reorder

array of object (BagsForReorder)

Items to be added to the cart when reordering a previous purchase.

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

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

meta

object

An object containing additional metadata for the order.

currency

object (CurrencySchema)

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.

Examples

Parameters

order_id:

"value"

Was this section helpful?

GET

/service/application/order/v1.0/orders/pos-order/{order_id}

1curl -X GET "https://api.fynd.com/service/application/order/v1.0/orders/pos-order/{order_id}" 
2 -H 'Authorization: Bearer {authorization_token}'

Try it

Response

1{
2  "order": {
3    "order_created_time": "2022-08-11T16:09:17.000Z",
4    "total_shipments_in_order": 1,
5    "order_id": "FY62F4CE260113EFCC64",
6    "charges": [],
7    "breakup_values": [
8      {
9        "name": "mrp_total",
10        "display": "MRP Total",
11        "value": 1000
12      },
13      {
14        "name": "sub_total",
15        "display": "Sub Total",
16        "value": 999
17      },
18      {
19        "name": "coupon",
20        "display": "Coupon",
21        "value": 0
22      },
23      {
24        "name": "discount",
25        "display": "Discount",
26        "value": -1
27      },
28      {
29        "name": "promotion",
30        "display": "Promotion",
31        "value": 0
32      },
33      {
34        "name": "reward_points",
35        "display": "Reward Points",
36        "value": 0
37      },
38      {
39        "name": "cashback_applied",
40        "display": "Cashback Applied",
41        "value": 0
42      },
43      {
44        "name": "delivery_charges",
45        "display": "Delivery Charges",
46        "value": 0
47      },
48      {
49        "name": "cod_charges",
50        "display": "COD Charges",
51        "value": 0
52      },
53      {
54        "name": "total",
55        "display": "Total",
56        "value": 999
57      }
58    ],
59    "shipments": [
60      {
61        "order_id": "FY62F4CE260113EFCC64",
62        "charges": [],
63        "breakup_values": [
64          {
65            "name": "mrp_total",
66            "display": "MRP Total",
67            "value": 1000
68          },
69          {
70            "name": "sub_total",
71            "display": "Sub Total",
72            "value": 999
73          },
74          {
75            "name": "coupon",
76            "display": "Coupon",
77            "value": 0
78          },
79          {
80            "name": "discount",
81            "display": "Discount",
82            "value": -1
83          },
84          {
85            "name": "promotion",
86            "display": "Promotion",
87            "value": 0
88          },
89          {
90            "name": "reward_points",
91            "display": "Reward Points",
92            "value": 0
93          },
94          {
95            "name": "cashback_applied",
96            "display": "Cashback Applied",
97            "value": 0
98          },
99          {
100            "name": "delivery_charges",
101            "display": "Delivery Charges",
102            "value": 0
103          },
104          {
105            "name": "cod_charges",
106            "display": "COD Charges",
107            "value": 0
108          },
109          {
110            "name": "total",
111            "display": "Total",
112            "value": 999
113          }
114        ],
115        "beneficiary_details": false,
116        "shipment_created_at": "2022-08-22T21:33:33.000Z",
117        "shipment_id": "16602143565551542371K",
118        "shipment_status": {
119          "title": "DP Assigned",
120          "value": "dp_assigned",
121          "hex_code": "#FE8F46"
122        },
123        "track_url": "",
124        "traking_no": "Tracking No.: 118022046",
125        "awb_no": "118022046",
126        "dp_name": "ecom_jio",
127        "tracking_details": [
128          {
129            "status": "Order Placed",
130            "time": "2022-08-11T16:09:17.000Z",
131            "is_passed": true,
132            "value": "processing"
133          },
134          {
135            "status": "Order Confirmed",
136            "time": "2022-08-22T17:14:02.000Z",
137            "is_passed": true,
138            "value": "confirmed"
139          },
140          {
141            "status": "Delivery Partner Assigned",
142            "time": "2022-08-22T17:14:13.000Z",
143            "is_passed": true,
144            "value": "dp_assigned"
145          },
146          {
147            "status": "In Transit",
148            "time": "",
149            "is_passed": false,
150            "value": "in_transit"
151          },
152          {
153            "status": "Out For Delivery",
154            "time": "",
155            "is_passed": false,
156            "value": "out_for_delivery"
157          },
158          {
159            "status": "Delivered",
160            "time": "",
161            "is_passed": false,
162            "value": "delivered"
163          }
164        ],
165        "total_bags": 1,
166        "order_type": "HomeDelivery",
167        "promise": {
168          "show_promise": false,
169          "timestamp": {
170            "dp_promise": null,
171            "min": "2022-08-15T09:38:44.000Z",
172            "max": "2022-08-18T09:38:44.000Z"
173          }
174        },
175        "bags": [
176          {
177            "id": 59987,
178            "charges": [],
179            "current_status": {
180              "status": "bag_not_picked",
181              "updated_at": "2022-08-22T21:33:33.000Z",
182              "name": "Bag Not Picked",
183              "journey_type": "forward"
184            },
185            "prices": {
186              "price_effective": 999,
187              "discount": 1,
188              "amount_paid": 999,
189              "coupon_effective_discount": 0,
190              "delivery_charge": 0,
191              "fynd_credits": 0,
192              "cod_charges": 0,
193              "refund_credit": 0,
194              "cashback": 0,
195              "refund_amount": 999,
196              "added_to_fynd_cash": false,
197              "cashback_applied": 0,
198              "gst_tax_percentage": 18,
199              "value_of_good": 846.61,
200              "price_marked": 1000,
201              "transfer_price": 0,
202              "brand_calculated_amount": 999,
203              "promotion_effective_discount": 0,
204              "coupon_value": 0,
205              "pm_price_split": {
206                "Net Banking": 999
207              }
208            },
209            "item": {
210              "name": "Puma Men Tshirt",
211              "brand": {
212                "name": "Dabur",
213                "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/kv5DZy0J8-Logo.jpeg"
214              },
215              "image": [
216                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/e6qJ_Bihn-61x838nYQUL._UL1440_.jpg"
217              ],
218              "slug_key": "puma-men-tshirt",
219              "size": "OS",
220              "code": "PUMATSHIRT",
221              "id": 7507572,
222              "category": [],
223              "seller_identifier": "PUMATSHIRT"
224            },
225            "financial_breakup": [
226              {
227                "price_effective": 999,
228                "discount": 1,
229                "amount_paid": 999,
230                "coupon_effective_discount": 0,
231                "delivery_charge": 0,
232                "fynd_credits": 0,
233                "cod_charges": 0,
234                "refund_credit": 0,
235                "cashback": 0,
236                "refund_amount": 999,
237                "added_to_fynd_cash": false,
238                "cashback_applied": 0,
239                "gst_tax_percentage": 18,
240                "value_of_good": 846.61,
241                "price_marked": 1000,
242                "transfer_price": 0,
243                "brand_calculated_amount": 999,
244                "promotion_effective_discount": 0,
245                "coupon_value": 0,
246                "pm_price_split": {
247                  "Net Banking": 999
248                },
249                "size": "OS",
250                "total_units": 1,
251                "hsn_code": "99972900",
252                "identifiers": {
253                  "sku_code": "PUMATSHIRT"
254                },
255                "item_name": "Puma Men Tshirt",
256                "gst_fee": 152.38,
257                "gst_tag": "IGST"
258              }
259            ],
260            "quantity": 1
261          }
262        ],
263        "size_info": {
264          "PUMATSHIRT": {
265            "quantity": 1,
266            "price_effective": 999,
267            "amount_paid": 999,
268            "price_marked": 1000,
269            "margin": 0.1
270          }
271        },
272        "total_details": {
273          "sizes": 1,
274          "total_price": 999,
275          "pieces": 1
276        },
277        "fulfilling_store": {
278          "name": "jio-location",
279          "company_id": 41,
280          "id": 8,
281          "code": "jio-location"
282        },
283        "fulfilling_company": {
284          "id": 41,
285          "name": "Jio"
286        }
287      }
288    ],
289    "is_validated": false
290  }
291}

Shipment

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

/service/application/order/v1.0/orders/shipments/{shipment_id}

# Get a Shipment

GET

/service/application/order/v1.0/orders/shipments/{shipment_id}/invoice

# Retrieves invoice for shipment

GET

/service/application/order/v1.0/orders/shipments/{shipment_id}/track

# Track shipment status

GET

/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/customer-details

# Get shipment's customer

POST

/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/send/

# Send OTP to customer

POST

/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/verify/

# Verifies OTP

GET

/service/application/order/v1.0/orders/shipments/{shipment_id}/reasons

# List shipment cancellation reasons

PUT

/service/application/order/v1.0/orders/shipments/{shipment_id}/status

# Updates shipment status

GET

Get a Shipment

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

Success.

ShipmentById

shipment

object (Shipments)

Shipments

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 (ShipmentPaymentInfo)

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 ShipmentPaymentInfo

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

Enum

gstin_code

string

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.

string

Email address of the user.

shipment_id

string

The unique identifier for the shipment.

fulfilling_store

object (FulfillingStore)

FulfillingStore

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

Schema for fulfilling store.

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

comment

string

Any comments related to the shipment.

invoice

object (Invoice)

Invoice

invoice_url

string

URL providing access to the invoice.

updated_date

string

| date-time

The date and time when the invoice was last updated.

label_url

string

URL providing access to the invoice label.

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

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.

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.

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

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

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.

number

The unique identifier of the item.

name

string

The name of the item.

l3_category_name

string

This key specifies the name of the third-level category under which the product is listed, offering a more detailed classification within the e-commerce platform's hierarchy.

slug_key

string

A unique key or identifier for the item slug.

l2_categories

array of string

An array of level 2 categories the item belongs to.

size

string

The size of the item.

attributes

object

An object containing various attributes of the item.

applied_promos

array of object (AppliedPromos)

An array containing information about applied promotions.

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

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

integer

The quantity of the item.

prices

object (Prices)

Prices

delivery_charge

number

The delivery charge for the order.

coupon_value

number

The value of the coupon applied.

brand_calculated_amount

number

The amount calculated by the brand.

value_of_good

number

The value of the goods before tax and other charges.

price_marked

number

The original marked price of the item.

coupon_effective_discount

number

The effective discount from coupons.

currency_symbol

string

The symbol of the currency used.

discount

number

The discount applied to the item.

gst_tax_percentage

number

The GST tax percentage applied.

cod_charges

number

The cash on delivery charges, if applicable.

amount_paid

number

The total amount paid by the customer.

added_to_fynd_cash

boolean

Indicates if the refund amount was added to Fynd Cash.

transfer_price

number

The transfer price of the item.

cashback_applied

number

The amount of cashback applied.

price_effective

number

The effective price after all adjustments.

cashback

number

The cashback amount earned.

refund_credit

number

The amount credited for refund .

amount_paid_roundoff

number

The rounded-off amount paid by the customer.

promotion_effective_discount

number

The effective discount from promotions.

refund_amount

number

The amount refunded to the customer.

currency_code

string

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.

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

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

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

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

Enum

article

object (Article)

Nullable

Article

tags

array of string

An array of tags associated with the article.

charges

array of object (PriceAdjustmentCharge)

An array of charges associated with the order item.

Array of PriceAdjustmentCharge

code

string

Nullable

Code defined for charge

name

string

Display name for charge (charge is unique by the name)

type

string

Nullable

Type defined for charge

amount

object (ChargeAmount)

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

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

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

Enum

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

Enum

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.

charges

array of object (PriceAdjustmentCharge)

An array of charge objects associated with the shipment.

Array of PriceAdjustmentCharge

code

string

Nullable

Code defined for charge

name

string

Display name for charge (charge is unique by the name)

type

string

Nullable

Type defined for charge

amount

object (ChargeAmount)

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 changes across all entity single: distribute the changes across to any one single entity

Enum

logic

string

distribution_level

string

This field defines the distribution level, e.g distribution level is (order, shipment, article)

Examples

Parameters

shipment_id:

"value"

allow_inactive:

false

Was this section helpful?

GET

/service/application/order/v1.0/orders/shipments/{shipment_id}

1curl -X GET "https://api.fynd.com/service/application/order/v1.0/orders/shipments/{shipment_id}" 
2 -H 'Authorization: Bearer {authorization_token}'

Try it

Response

1{
2  "shipment": {
3    "order_id": "FY62F3B8290150D13E36",
4    "order": {
5      "meta": {
6        "custom_cart_id": "652ce6972512f05477a32547",
7        "name": "Universal/Smart Bazar/Fresh Cart",
8        "slug": "universal/smart-bazar/fresh-cart"
9      }
10    },
11    "charges": [],
12    "breakup_values": [
13      {
14        "name": "mrp_total",
15        "display": "MRP Total",
16        "value": 50
17      },
18      {
19        "name": "sub_total",
20        "display": "Sub Total",
21        "value": 50
22      },
23      {
24        "name": "coupon",
25        "display": "Coupon",
26        "value": 0
27      },
28      {
29        "name": "discount",
30        "display": "Discount",
31        "value": 0
32      },
33      {
34        "name": "promotion",
35        "display": "Promotion",
36        "value": 0
37      },
38      {
39        "name": "reward_points",
40        "display": "Reward Points",
41        "value": 0
42      },
43      {
44        "name": "cashback_applied",
45        "display": "Cashback Applied",
46        "value": 0
47      },
48      {
49        "name": "delivery_charges",
50        "display": "Delivery Charges",
51        "value": 0
52      },
53      {
54        "name": "cod_charges",
55        "display": "COD Charges",
56        "value": 0
57      },
58      {
59        "name": "amount_to_be_collected",
60        "display": "Amount To Be Collected",
61        "value": 0
62      },
63      {
64        "name": "total",
65        "display": "Total",
66        "value": 50
67      }
68    ],
69    "beneficiary_details": false,
70    "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
71    "shipment_created_at": "2022-08-10T19:22:42.000Z",
72    "shipment_id": "16601395620321798247K",
73    "shipment_status": {
74      "title": "DP Assigned",
75      "value": "dp_assigned",
76      "hex_code": "#FE8F46"
77    },
78    "track_url": "",
79    "traking_no": "Tracking No.: 5923410031146",
80    "awb_no": "5923410031146",
81    "dp_name": "delhivery_jio_surface",
82    "tracking_details": [
83      {
84        "status": "Order Placed",
85        "time": "2022-08-10T19:22:55.000Z",
86        "is_passed": true,
87        "value": "processing"
88      },
89      {
90        "status": "Order Confirmed",
91        "time": "2022-08-18T19:11:02.000Z",
92        "is_passed": true,
93        "value": "confirmed"
94      },
95      {
96        "status": "Delivery Partner Assigned",
97        "time": "2022-08-18T19:11:38.000Z",
98        "is_passed": true,
99        "value": "dp_assigned"
100      },
101      {
102        "status": "In Transit",
103        "time": "",
104        "is_passed": false,
105        "value": "in_transit"
106      },
107      {
108        "status": "Out For Delivery",
109        "time": "",
110        "is_passed": false,
111        "value": "out_for_delivery"
112      },
113      {
114        "status": "Delivered",
115        "time": "",
116        "is_passed": false,
117        "value": "delivered"
118      }
119    ],
120    "total_bags": 1,
121    "promise": {
122      "show_promise": false,
123      "timestamp": {
124        "min": "2022-08-14T13:52:37.000Z",
125        "max": "2022-08-17T13:52:37.000Z",
126        "dp_promise": null
127      }
128    },
129    "bags": [
130      {
131        "id": 59624,
132        "charges": [],
133        "current_status": {
134          "status": "bag_not_picked",
135          "updated_at": "2022-08-18T23:46:11.000Z",
136          "name": "Bag Not Picked",
137          "journey_type": "forward"
138        },
139        "prices": {
140          "price_effective": 50,
141          "discount": 0,
142          "amount_paid": 50,
143          "coupon_effective_discount": 0,
144          "delivery_charge": 0,
145          "fynd_credits": 0,
146          "cod_charges": 0,
147          "refund_credit": 0,
148          "cashback": 0,
149          "refund_amount": 50,
150          "added_to_fynd_cash": false,
151          "cashback_applied": 0,
152          "gst_tax_percentage": 18,
153          "value_of_good": 42.37,
154          "price_marked": 50,
155          "transfer_price": 0,
156          "brand_calculated_amount": 50,
157          "promotion_effective_discount": 0,
158          "coupon_value": 0,
159          "amount_to_be_collected": 0,
160          "pm_price_split": {
161            "COD": 50
162          }
163        },
164        "item": {
165          "name": "Tissues",
166          "l2_category": [
167            "Tools & Accessories"
168          ],
169          "l2_category_id": 3,
170          "brand": {
171            "name": "Zepto",
172            "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/5XLRHXC5H-Logo.png"
173          },
174          "image": [
175            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/hGov80Pbv-411yLXtNYNL._SL1000_.jpg",
176            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
177            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
178            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
179            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
180            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
181            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
182            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
183            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
184            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
185            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg"
186          ],
187          "slug_key": "tissues",
188          "size": "OS",
189          "code": "TIS-102",
190          "id": 7500474,
191          "seller_identifier": "987432134",
192          "attributes": {}
193        },
194        "financial_breakup": [
195          {
196            "price_effective": 50,
197            "discount": 0,
198            "amount_paid": 50,
199            "coupon_effective_discount": 0,
200            "delivery_charge": 0,
201            "fynd_credits": 0,
202            "cod_charges": 0,
203            "refund_credit": 0,
204            "cashback": 0,
205            "refund_amount": 50,
206            "added_to_fynd_cash": false,
207            "cashback_applied": 0,
208            "gst_tax_percentage": 18,
209            "value_of_good": 42.37,
210            "price_marked": 50,
211            "transfer_price": 0,
212            "brand_calculated_amount": 50,
213            "promotion_effective_discount": 0,
214            "coupon_value": 0,
215            "amount_to_be_collected": 0,
216            "pm_price_split": {
217              "COD": 50
218            },
219            "size": "OS",
220            "total_units": 1,
221            "hsn_code": "70099200",
222            "identifiers": {
223              "sku_code": "987432134"
224            },
225            "item_name": "Tissues",
226            "gst_fee": 7.62,
227            "gst_tag": "SGST"
228          }
229        ],
230        "quantity": 1,
231        "departments": [
232          31
233        ],
234        "can_cancel": false,
235        "can_return": false
236      }
237    ],
238    "size_info": {
239      "TIS-102": {
240        "quantity": 1,
241        "price_effective": 50,
242        "amount_paid": 50,
243        "price_marked": 50,
244        "margin": 0
245      }
246    },
247    "total_details": {
248      "sizes": 1,
249      "total_price": 50,
250      "pieces": 1
251    },
252    "fulfilling_store": {
253      "name": "Jio-market-store3",
254      "company_id": 33,
255      "id": 50,
256      "code": "store3",
257      "tags": [
258        "infibeam"
259      ]
260    },
261    "fulfilling_company": {
262      "id": 33,
263      "name": "RELIANCE JIO INFOCOMM LIMITED"
264    },
265    "gstin_code": "27AALCA0442L1ZM",
266    "billing_address": {
267      "id": "62e8fc91c1700b808fe528bd",
268      "uid": 745,
269      "area": "test",
270      "city": "Mumbai",
271      "name": "abc",
272      "email": "test@example.com",
273      "phone": "8888888888",
274      "state": "Maharashtra",
275      "address": "1234",
276      "country": "India",
277      "pincode": "400074",
278      "version": "1.0",
279      "address1": " test",
280      "address2": "",
281      "landmark": "test",
282      "latitude": 19.0653252,
283      "address_1": " test",
284      "area_code": "400074",
285      "longitude": 72.8423802,
286      "created_at": "2022-08-10T18:52:38.000Z",
287      "updated_at": "2022-08-10T18:52:38.000Z",
288      "address_type": "home",
289      "country_code": "91",
290      "geo_location": {
291        "latitude": 19.0653252,
292        "longitude": 72.8423802
293      },
294      "area_code_slug": "pincode",
295      "delivery_address_id": 745,
296      "addressee_name": "abc",
297      "delivery_code_required": 1
298    },
299    "delivery_address": {
300      "id": "62e8fc91c1700b808fe528bd",
301      "uid": 745,
302      "area": "test",
303      "city": "Mumbai",
304      "name": "abc",
305      "email": "test@example.com",
306      "phone": "8888888888",
307      "state": "Maharashtra",
308      "address": "1234",
309      "country": "India",
310      "pincode": "400074",
311      "version": "1.0",
312      "address1": " test",
313      "address2": "",
314      "landmark": "test",
315      "latitude": 19.0653252,
316      "address_1": " test",
317      "area_code": "400074",
318      "longitude": 72.8423802,
319      "created_at": "2022-08-10T18:52:38.000Z",
320      "updated_at": "2022-08-10T18:52:38.000Z",
321      "address_type": "home",
322      "country_code": "91",
323      "geo_location": {
324        "latitude": 19.0653252,
325        "longitude": 72.8423802
326      },
327      "area_code_slug": "pincode",
328      "delivery_address_id": 745,
329      "addressee_name": "abc",
330      "delivery_code_required": 1
331    },
332    "can_cancel": false,
333    "can_return": false,
334    "delivery_date": null,
335    "returnable_date": null,
336    "show_download_invoice": true,
337    "show_track_link": true,
338    "prices": {
339      "amount_paid": 50,
340      "refund_amount": 50,
341      "price_marked": 50,
342      "cod_charges": 0,
343      "coupon_value": 0,
344      "discount": 0,
345      "cashback_applied": 0,
346      "delivery_charge": 0,
347      "fynd_credits": 0,
348      "cashback": 0,
349      "price_effective": 50,
350      "refund_credit": 0,
351      "value_of_good": 42.37,
352      "amount_to_be_collected": 0
353    },
354    "can_break": {
355      "bag_not_picked": {
356        "can_break_entity": false
357      },
358      "cancelled_customer": {
359        "can_break_entity": true
360      },
361      "bag_picked": {
362        "can_break_entity": false
363      },
364      "cancelled_fynd": {
365        "can_break_entity": true
366      },
367      "bag_rescheduled": {
368        "can_break_entity": false
369      },
370      "cancelled_at_dp": {
371        "can_break_entity": false
372      },
373      "handed_over_to_dg": {
374        "can_break_entity": false
375      },
376      "dp_assigned": {
377        "can_break_entity": false
378      },
379      "cancelled_operations": {
380        "can_break_entity": false
381      },
382      "cancelled_seller": {
383        "can_break_entity": false
384      },
385      "out_for_pickup": {
386        "can_break_entity": false
387      },
388      "bag_pick_failed": {
389        "can_break_entity": false
390      },
391      "update_qr_code": {
392        "can_break_entity": false
393      }
394    },
395    "payment": {
396      "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
397      "mode": "Jio Partner Pay",
398      "mop": "COD",
399      "display_name": "COD",
400      "payment_mode": "COD",
401      "status": "Unpaid"
402    },
403    "payment_info": [
404      {
405        "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
406        "mode": "Jio Partner Pay",
407        "mop": "COD",
408        "display_name": "COD",
409        "payment_mode": "COD",
410        "status": "Unpaid"
411      }
412    ],
413    "user_info": {
414      "email": "test@example.com",
415      "gender": "male",
416      "mobile": "8888888888",
417      "name": "User -"
418    },
419    "comment": "",
420    "invoice": {
421      "updated_date": "2022-08-18T19:11:02.000Z",
422      "store_invoice_id": "00000050AA000147",
423      "invoice_url": "",
424      "label_url": ""
425    },
426    "refund_details": {
427      "rrn": ""
428    }
429  }
430}

GET

Retrieves invoice for shipment

Get invoice corresponding to a specific shipment ID.

Parameters

shipment_id

string

Required

Unique identifier for a shipment.

Response

200

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.

Examples

Parameters

Parameters are not required.

Was this section helpful?

GET

/service/application/order/v1.0/orders/shipments/{shipment_id}/invoice

1curl -X GET "https://api.fynd.com/service/application/order/v1.0/orders/shipments/{shipment_id}/invoice" 
2 -H 'Authorization: Bearer {authorization_token}'

Try it

Response

Example not available.

GET

Track shipment status

Track Shipment by shipment id, for application based on application 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.

Default Value : 16544950215681060915J

Response

200

Success.

ShipmentTrack

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.

meta

object

A field to store additional metadata related to the courier partner's operations or the shipment.

Examples

Parameters

shipment_id:

"value"

Was this section helpful?

GET

/service/application/order/v1.0/orders/shipments/{shipment_id}/track

1curl -X GET "https://api.fynd.com/service/application/order/v1.0/orders/shipments/{shipment_id}/track" 
2 -H 'Authorization: Bearer {authorization_token}'

Try it

Response

1{
2  "results": [
3    {
4      "updated_at": "11 Oct, 12:14 PM",
5      "last_location_recieved_at": "Mumbai MIDC (Maharashtra)",
6      "reason": "Delhivery Delhivery vaishakh - eway bill 1 100kg 1-100kg",
7      "shipment_type": "forward",
8      "status": "bag_not_picked",
9      "updated_time": "2024-10-11T12:14:10+5:30",
10      "account_name": "Delhivery Delhivery vaishakh - eway bill 1 100kg 1-100kg",
11      "awb": "5638010004340",
12      "raw_status": "UD-Not Picked|Shipment not received from client",
13      "meta": {
14        "remark": "Shipment not received from client",
15        "is_polling": true,
16        "courier_partner_scheme_id": "6572f74821fabd7e53660e4b",
17        "courier_partner_extension_id": "656da76de7b208e46ca12f97",
18        "courier_partner_shipper_name": "Delhivery"
19      }
20    }
21  ]
22}

GET

Get shipment's customer

Get customer details such as mobile number using Shipment ID.

Parameters

order_id

string

Required

A unique number used for identifying and tracking your orders.

Default Value : 16544950215681060915J

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.

Default Value : FY6299E19701B4EAEFC2

Response

200

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:

"value"

shipment_id:

"value"

Was this section helpful?

GET

/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/customer-details

1curl -X GET "https://api.fynd.com/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/customer-details" 
2 -H 'Authorization: Bearer {authorization_token}'

Try it

Response

1{
2  "order_id": "FYMP629D972D01B6BD76",
3  "shipment_id": "16544950215681060915J",
4  "name": "sagar Kulkarni",
5  "phone": "XXX-XXX-6780",
6  "country": "India"
7}

POST

Send OTP to customer

Send OTP to the customer for shipment verification.

Parameters

order_id

string

Required

A unique number used for identifying and tracking your orders.

Default Value : FY6299E19701B4EAEFC2

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.

Default Value : 16544950215681060915J

Response

200

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:

"value"

shipment_id:

"value"

Was this section helpful?

POST

/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/send/

1curl -X POST "https://api.fynd.com/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/send/" 
2 -H 'Authorization: Bearer {authorization_token}'
3 -H 'Content-Type: application/json'

Try it

Response

1{
2  "success": true,
3  "request_id": "0fe0d6e16205ddc57d212e947ee31896",
4  "message": "OTP sent",
5  "resend_timer": 30
6}

POST

Verifies OTP

Verify OTP for getting shipment details

Parameters

order_id

string

Required

A string that represents the unique identifier assigned to the order.

Default Value : FYMP6294545C010B89FD

shipment_id

string

Required

The unique identifier for the shipment.

Default Value : 16538880933361957252J

Request body

otp_code

string

The OTP code provided by the user for verification.

request_id

string

Unique identifier for the request.

Response

200

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:

"value"

shipment_id:

"value"

body:

body

Was this section helpful?

POST

/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/verify/

1curl -X POST "https://api.fynd.com/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/verify/" 
2 -H 'Authorization: Bearer {authorization_token}'
3 -H 'Content-Type: application/json' 
4-d '{
5  "otp_code": "value",
6  "request_id": "value"
7}'

Try it

Response

1{
2  "success": true,
3  "message": ""
4}

GET

List shipment cancellation reasons

Get reasons to perform full or partial cancellation of a shipment.

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

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:

"value"

Was this section helpful?

GET

/service/application/order/v1.0/orders/shipments/{shipment_id}/reasons

1curl -X GET "https://api.fynd.com/service/application/order/v1.0/orders/shipments/{shipment_id}/reasons" 
2 -H 'Authorization: Bearer {authorization_token}'

Try it

Response

1{
2  "reasons": [
3    {
4      "reason_id": 115,
5      "priority": 9,
6      "reason_text": "Wrong size/colour delivered",
7      "show_text_area": false,
8      "feedback_type": "bag",
9      "flow": "return"
10    },
11    {
12      "reason_id": 116,
13      "priority": 10,
14      "reason_text": "Product does not fit me",
15      "show_text_area": false,
16      "feedback_type": "bag",
17      "flow": "return"
18    },
19    {
20      "reason_id": 117,
21      "priority": 11,
22      "reason_text": "Quality of product is not good",
23      "show_text_area": false,
24      "feedback_type": "bag",
25      "flow": "return"
26    },
27    {
28      "reason_id": 118,
29      "priority": 12,
30      "reason_text": "Wrong product delivered",
31      "show_text_area": true,
32      "feedback_type": "bag",
33      "flow": "return"
34    },
35    {
36      "reason_id": 119,
37      "priority": 13,
38      "reason_text": "Damaged product delivered",
39      "show_text_area": true,
40      "feedback_type": "bag",
41      "flow": "return"
42    },
43    {
44      "reason_id": 120,
45      "priority": 14,
46      "reason_text": "Used product delivered",
47      "show_text_area": true,
48      "feedback_type": "bag",
49      "flow": "return"
50    },
51    {
52      "reason_id": 124,
53      "priority": 15,
54      "reason_text": "Missing Items/Partially Received",
55      "show_text_area": true,
56      "feedback_type": "bag",
57      "flow": "return"
58    },
59    {
60      "reason_id": 121,
61      "priority": 16,
62      "reason_text": "Found better price elsewhere",
63      "show_text_area": true,
64      "feedback_type": "bag",
65      "flow": "return"
66    },
67    {
68      "reason_id": 122,
69      "priority": 17,
70      "reason_text": "Product looks different from image",
71      "show_text_area": true,
72      "feedback_type": "bag",
73      "flow": "return"
74    },
75    {
76      "reason_id": 123,
77      "priority": 18,
78      "reason_text": "Other issue",
79      "show_text_area": true,
80      "feedback_type": "bag",
81      "flow": "return"
82    }
83  ]
84}

PUT

Updates shipment status

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.

body

object (UpdateShipmentStatusRequestSchema)

Required

UpdateShipmentStatusRequestSchema

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.

Request body

statuses

array of object (StatuesRequestSchema)

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

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:

"value"

body:

body

Was this section helpful?

PUT

/service/application/order/v1.0/orders/shipments/{shipment_id}/status

1curl -X PUT "https://api.fynd.com/service/application/order/v1.0/orders/shipments/{shipment_id}/status" 
2 -H 'Authorization: Bearer {authorization_token}'
3 -H 'Content-Type: application/json' 
4-d '{
5  "statuses": [
6    {
7      "shipments": [
8        {
9          "identifier": "16722505549091367924",
10          "products": [
11            {
12              "line_number": 1,
13              "quantity": 2
14            }
15          ],
16          "reasons": {
17            "products": [
18              {
19                "filters": [
20                  {
21                    "line_number": 1,
22                    "quantity": 2
23                  }
24                ],
25                "data": {
26                  "reason_id": 84,
27                  "reason_text": ""
28                }
29              }
30            ]
31          },
32          "data_updates": {
33            "products": [
34              {
35                "filters": [],
36                "data": {
37                  "meta": {
38                    "return_qc_json": {
39                      "images": [],
40                      "return_reason": {
41                        "id": 3,
42                        "display_name": "Size is M",
43                        "meta": {
44                          "show_text_area": false
45                        },
46                        "qc_type": [],
47                        "reasons": [],
48                        "question_set": [
49                          {
50                            "id": 84,
51                            "display_name": "Check the brand"
52                          }
53                        ]
54                      },
55                      "reason_options": []
56                    }
57                  }
58                }
59              }
60            ],
61            "entities": [
62              {
63                "filters": [],
64                "data": {
65                  "meta": {
66                    "qc_requried": false
67                  }
68                }
69              }
70            ]
71          }
72        }
73      ],
74      "status": "return_initiated"
75    }
76  ],
77  "task": false,
78  "lock_after_transition": false,
79  "force_transition": false,
80  "unlock_before_transition": false
81}'

Try it

Response

1{
2  "statuses": [
3    {
4      "shipments": [
5        {
6          "16291129095851065963": {
7            "status": 400,
8            "message": {
9              "16291129095851065963": "Invalid State Transition bag_invoiced detected for given entity"
10            },
11            "code": null,
12            "exception": "ValidationError",
13            "stack_trace": null
14          }
15        }
16      ]
17    }
18  ]
19}

« Get pincode details

Rupifi banner info »