Note: You are viewing an older version of the documentation. Click here to go the latest version
Order
Manages orders, including processing, tracking, and updating order status.
The Account module is responsible for managing channel accounts within a company. Channel accounts represent different sales channels or marketplaces through which products are sold. This module provides functionality to create, retrieve, update, and list channel accounts, enabling businesses to manage multiple sales channels from a single platform.
Operations
POST
# Create channel account
GET
# Get channel accounts list
GET
# Get channel account details
PUT
# Update account
Creates a new channel account for the company. Channel accounts represent different sales channels or marketplace integrations (e.g., Shopify, custom marketplaces) through which the company receives and processes orders. Each account is identified by a unique name and can be used to segregate orders from different sources.
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
bodyrequestBody
object (CreateAccount)
Required
Hide
channel_account_name
string
Required
Unique name identifier for the channel account. This represents the sales channel or marketplace through which orders are received and processed.
Request body
channel_account_name
string
Required
Unique name identifier for the channel account. This represents the sales channel or marketplace through which orders are received and processed.
POST
Response
200
Account created successfully
Hide
channel_account_id
string
Unique identifier for the channel account. This is a system-generated identifier used to reference the account across the platform.
company_id
integer
Unique identifier of the company on the platform to which this channel account belongs.
channel_account_name
string
Name of the channel account. This identifies the specific sales channel or marketplace (e.g., SHOPIFY, MARKETPLACE, etc.) through which the company receives and processes orders.
Examples
Parameters
Parameters are not required.
Response
Create channel account
createAccount
Retrieves a paginated list of all channel accounts configured for the company. Channel accounts represent different sales channels or marketplace integrations from which orders are received. This endpoint returns account details including the account ID, company ID, and channel account name for each configured channel.
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
pagequery
integer
The page number to retrieve in the paginated results. Default is page 1.
Default Value : 1
sizequery
integer
Number of channel accounts to return per page. Default is 20 items per page.
Default Value : 20
GET
Response
200
Successfully retrieved list of accounts
Hide
data
array of object (Account)
List of channel accounts associated with the company. Each account represents a different sales channel or marketplace integration.
Show
channel_account_id
string
Unique identifier for the channel account. This is a system-generated identifier used to reference the account across the platform.
company_id
integer
Unique identifier of the company on the platform to which this channel account belongs.
channel_account_name
string
Name of the channel account. This identifies the specific sales channel or marketplace (e.g., SHOPIFY, MARKETPLACE, etc.) through which the company receives and processes orders.
page
object (Page)
Show
An object representing a page with pagination details.
item_total
integer
| int32
The total number of all items across all pages.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, can be 'cursor' or 'number'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Examples
Parameters
Parameters are not required.
Response
Get channel accounts list
listAccounts
Retrieves detailed information about a specific channel account using its unique identifier. This endpoint returns the complete account details including the account ID, associated company ID, and the channel account name. Use this to fetch information about a particular sales channel or marketplace integration.
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
channel_account_idpath
string
Required
Unique identifier of the channel account to retrieve.
GET
Response
200
Successfully retrieved account details
Hide
channel_account_id
string
Unique identifier for the channel account. This is a system-generated identifier used to reference the account across the platform.
company_id
integer
Unique identifier of the company on the platform to which this channel account belongs.
channel_account_name
string
Name of the channel account. This identifies the specific sales channel or marketplace (e.g., SHOPIFY, MARKETPLACE, etc.) through which the company receives and processes orders.
Response
Get channel account details
getAccountById
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
channel_account_idpath
string
Required
Unique identifier of the account.
bodyrequestBody
object (CreateAccount)
Required
Hide
channel_account_name
string
Required
Unique name identifier for the channel account. This represents the sales channel or marketplace through which orders are received and processed.
Request body
channel_account_name
string
Required
Unique name identifier for the channel account. This represents the sales channel or marketplace through which orders are received and processed.
PUT
Response
200
Account updated successfully
Hide
channel_account_id
string
Unique identifier for the channel account. This is a system-generated identifier used to reference the account across the platform.
company_id
integer
Unique identifier of the company on the platform to which this channel account belongs.
channel_account_name
string
Name of the channel account. This identifies the specific sales channel or marketplace (e.g., SHOPIFY, MARKETPLACE, etc.) through which the company receives and processes orders.
Response
Update account
updateAccount
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
# List bag cancellation reasons
GET
# Get bag
GET
# List bags
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
shipment_idpath
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
bag_idpath
string
Required
ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
statepath
string
Required
State for which reasons are required.
GET
Response
200
Success.
Hide
reasons
array of object (Reason)
An array of reasons associated with the platform.
Show
id
integer
A unique identifier for the reason.
display_name
string
The display name for the reason, used for user-facing purposes.
reasons
array of object (Reason)
A list of sub-reasons under the main reason. These provide additional layers of granularity to the main reason.
Show
qc_type
array of string
List of QC (Quality Control) types -- having return reason types indicating the stage at which QC is performed. - "Doorstep QC" refers involves inspecting products for damages at the customer's location before delivery. - "Pre QC" requires customers to upload product photos for a preliminary quality check by the operations team before a return or exchange pickup is arranged, ensuring criteria are met and optimizing logistics.
Enum
question_set
array of object (QuestionSet)
An array of question sets linked to the reason, defining the questions to be answered.
Show
id
integer
A unique identifier for the question set.
display_name
string
The display name for the question set, used for user-facing purposes.
meta
object
Meta object of the reason. This contains any additional metadata that might be relevant to the reason.
is_active
boolean
Indicates whether the reason is currently active. Active reasons are those that are currently in use within the system.
success
boolean
Indicates whether the API call was successful (true) or not (false).
Response
List bag cancellation reasons
getShipmentReasons
Parameters
company_idpath
integer
Required
Unique identifier of a company
bag_idquery
string
Unique identifier of a bag
channel_bag_idquery
string
Id of application bag
channel_idquery
string
Id of application
GET
Response
200
Successfully retrived shipment details!
Hide
status_code
integer
Response status_code.
Enum
data
object (BagDetails)
Show
bag_update_time
number
Nullable
The timestamp indicating when the bag's information was last updated
id
string
Nullable
A unique identifier for the bag record within the system.
bag_id
integer
Nullable
A unique identifier specifically for the bag itself, used for tracking purposes.
affiliate_bag_details
object (AffiliateBagDetails)
Show
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_order_id
string
Unique identifier for the affiliate order associated with the bag.
employee_discount
number
Nullable
Discount percentage or amount applicable to employees for this order.
affiliate_bag_id
string
Unique identifier for the affiliate bag, used for tracking and reference.
loyalty_discount
number
| float
Discount amount applied based on customer loyalty, if applicable.
affiliate_details
object (AffiliateDetails)
Show
Details of an affiliate associated with a shipment.
shipment_meta
object (ShipmentMeta)
Show
tracking_url
string
Nullable
A URL for tracking the shipment.
estimated_delivery_date
string
| date-time
Nullable
Provides a forecasted date and time by which the shipment is expected to be delivered to the recipient. This estimation is crucial for planning purposes, both for the sender in managing expectations and for the recipient in preparing for receipt.
same_store_available
boolean
Indicates whether the shipment is available for pickup from the same store.
b2b_buyer_details
object (BuyerDetails)
Show
ajio_site_id
string
Nullable
The unique identifier for the buyer on the Ajio platform.
pincode
integer
The postal code for the buyer's shipping address, used for delivery location identification.
address
string
Provides the comprehensive address details of the buyer's shipping address.
gstin
string
The Goods and Services Tax Identification Number (GSTIN) of the buyer.
name
string
The full name of the buyer, essential for personalizing communication and delivery.
state
string
The name of the state where the buyer's shipping address is located, important for logistical purposes.
city
string
The name of the city where the buyer's shipping address is located, which helps in identifying delivery zones.
formatted
object (Formatted)
Show
max
string
Nullable
Represents the maximum formatted value, providing a limit for the associated data, such as dimensions or weights.
min
string
Nullable
Represents the minimum formatted value, establishing a lower limit for the associated data, ensuring it meets certain criteria or standards.
debug_info
object (DebugInfo)
Show
stormbreaker_uuid
string
Nullable
A unique identifier (UUID) associated with the Stormbreaker system, used for tracking and debugging purposes in the application.
return_awb_number
string
Nullable
The Air Waybill (AWB) number associated with a return shipment.
is_self_ship
boolean
Nullable
Indicates whether the shipment is a self-shipped order.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
einvoice_info
object (EinvoiceInfo)
Show
credit_note
object
Nullable
Specifies the reverse einvoice transaction create on government portal.
invoice
object
Nullable
It specifies the forward einvoice transaction created on government portal.
return_affiliate_shipment_id
string
Nullable
The shipment ID associated with a return from an affiliate.
parent_dp_id
string
Nullable
The unique identifier for the parent delivery partner.
shipment_weight
number
Nullable
The total weight of the shipment.
dimension
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment.
assign_dp_from_sb
boolean
Nullable
Indicates whether to assign the delivery partner from the store’s basket.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
store_invoice_updated_date
string
| date-time
Nullable
Denotes the date and time when the store's invoice related to this shipment was updated. This timestamp is vital for tracking changes to billing details, adjustments in charges, or updates in the invoicing status.
forward_affiliate_shipment_id
string
Nullable
The shipment ID for the forward journey of an affiliate shipment.
return_store_node
integer
Nullable
The identifier for the store node involved in the return process.
fulfilment_priority_text
string
Nullable
Textual representation of the fulfillment priority for the shipment.
shipment_tags
array of object (ShipmentTags)
Tags associated with the shipment for categorization and filtering.
Show
slug
string
Nullable
A URL-friendly string representing the tag, often used for routing or categorization.
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
display_text
string
Nullable
A human-readable text representation of the tag, used for display purposes in user interfaces.
external
object
Nullable
External metadata related to the shipment.
awb_number
string
Nullable
The Air Waybill number associated with the shipment.
lock_data
object (LockData)
Show
locked
boolean
Nullable
Indicates whether the shipment is currently locked for processing (true) or not (false).
mto
boolean
Nullable
A flag indicating whether the shipment is part of a multi-modal transport operation.
lock_message
string
Nullable
An optional message providing additional context or information regarding the lock status.
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.
Enum
ewaybill_info
object
Nullable
Electronic Way Bill details i.e ewayBillNo, ewayBillDate that are utilized in the transportation of goods.
dp_id
string
Nullable
The unique identifier for the delivery partner associated with the shipment.
shipment_volumetric_weight
number
Nullable
The volumetric weight of the shipment, which may differ from its actual weight.
marketplace_store_id
string
Nullable
The unique identifier for the marketplace store associated with the shipment.
return_details
object
Nullable
An object containing the return details of the shipment.
dp_sort_key
string
Nullable
A sort key for the delivery partner, used for prioritization.
packaging_name
string
Nullable
The name of the packaging used for the shipment.
timestamp
object (ShipmentTimeStamp)
Show
max
integer
Nullable
Represents the maximum timestamp value, indicating the latest time relevant to the shipment.
min
integer
Nullable
Represents the minimum timestamp value, indicating the earliest time relevant to the shipment.
auto_trigger_dp_assignment_acf
boolean
Nullable
Indicates whether automatic delivery partner assignment is triggered for this shipment.
dp_name
string
Nullable
The name of the delivery partner associated with the shipment.
po_number
string
Nullable
The purchase order number associated with the shipment.
weight
integer
The weight of the shipment, typically measured in grams or kilograms.
b2c_buyer_details
object
Nullable
Contains detailed information about the buyer in a business-to-consumer (B2C) transaction. This object is designed to capture a wide array of buyer-specific data such as contact information, shipping address, preferences, and any other relevant details that enhance the understanding of the buyer's profile and needs.
forward_affiliate_order_id
string
Nullable
The order ID for the forward journey of an affiliate shipment.
return_affiliate_order_id
string
Nullable
The order ID for the return journey of an affiliate shipment.
bag_weight
object
Nullable
This object is designed to accommodate a range of weight-related information. Denotes the weight of the bag, potentially including various measurements or related details.
refund_to
string
Nullable
Specifies the recipient of any refunds related to the shipment.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_shipment_id
string
The shipment ID specific to this affiliate.
company_affiliate_tag
string
Nullable
An optional tag representing the company's affiliate association.
affiliate_order_id
string
The order ID associated with the affiliate shipment.
pdf_links
object (PDFLinks)
Show
invoice_type
string
The type of invoice issued, such as 'fynd' or other classifications.
Enum
label_a6
string
Nullable
URL or path to the A6 size label document.
invoice
string
Nullable
URL or path to the main invoice document.
label_pos
string
Nullable
URL or path to the POS label document.
invoice_a6
string
Nullable
URL or path to the A6 size invoice document.
b2b
string
Nullable
URL or path to the B2B document related to the transaction.
label
string
Nullable
URL or path to the general label document.
label_a4
string
Nullable
URL or path to the A4 size label document.
label_type
string
Specifies the type of label associated with a PDF document,indicating its purpose or content. The label_type helps in organizing and identifying PDF documents quickly, ensuring that users or systems can efficiently utilize the correct documents for required actions.
Enum
invoice_export
string
Nullable
URL or path to the exported invoice document.
credit_note_url
string
Nullable
URL or path to the credit note document.
delivery_challan_a4
string
Nullable
URL or path to the A4 delivery challan document.
label_export
string
Nullable
URL or path to the exported label document.
invoice_a4
string
Nullable
URL or path to the A4 size invoice document.
invoice_pos
string
Nullable
URL or path to the POS invoice document.
po_invoice
string
Nullable
URL or path to the purchase order invoice document.
config
object (AffiliateConfig)
Show
app
object (AffiliateAppConfig)
Show
id
string
description
string
updated_at
string
| date-time
The date and time when the app config was updated.
name
string
token
string
meta
array of object (AffiliateAppConfigMeta)
Show
value
string
name
string
owner
string
secret
string
created_at
string
| date-time
Timestamp when the app config was created.
inventory
object (AffiliateInventoryConfig)
Show
article_assignment
object (AffiliateInventoryArticleAssignmentConfig)
Show
post_order_reassignment
boolean
payment
object (AffiliateInventoryPaymentConfig)
Show
source
string
mode_of_payment
string
inventory
object (AffiliateInventoryStoreConfig)
Show
store
object
Fulfilling store information related to the shipment.
order
object (AffiliateInventoryOrderConfig)
Show
force_reassignment
boolean
logistics
object (AffiliateInventoryLogisticsConfig)
Show
dp_assignment
boolean
app_company_id
integer
Nullable
A unique identifier for the company associated with the affiliate app, used for tracking and managing affiliate relationships.
affiliate_id
string
Nullable
The unique identifier for the affiliate.
affiliate_store_id
string
The unique identifier for the affiliate's store.
affiliate_bag_id
string
The unique identifier for the affiliate's bag.
id
string
Nullable
The unique identifier for the affiliate.
applied_promos
array of object
Nullable
A list of promotional discounts that were applied to the bag's contents.
article
object (Article)
Show
seller_identifier
string
Unique identifier assigned by the seller to the article, used for inventory management.
uid
string
A unique identifier for the article within the system.
set
object
Nullable
Represents the data related to combinations of articles that, while being the same product, vary by size, color, or other distinguishing features.
dimensions
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
currency
object
Nullable
Currency in which the transaction amount associated with the article is specified.
esp_modified
boolean
Nullable
Indicates whether the article has been modified by the ESP (e-commerce service provider).
return_config
object (ReturnConfig)
Nullable
Configuration related to the return policy for the article.
Show
returnable
boolean
Nullable
Indicates whether the article is eligible for return, allowing customers to send it back under specified conditions.
time
number
Nullable
The time frame within which the return must be initiated, typically measured in days.
unit
string
Nullable
The unit of time for the return period (e.g., days, weeks).
code
string
Nullable
Internal code or identifier for the article, used for reference.
weight
object (Weight)
Show
is_default
boolean
Nullable
Indicates whether this weight value is the default weight used for the article.
shipping
integer
Nullable
The weight of the article specifically for shipping purposes, usually measured in grams or kilograms.
unit
string
Nullable
The unit of measurement for the weight (e.g., grams, kilograms, pounds).
_id
string
The unique identifier for the article within the database.
identifiers
object
Details of identifiers associated with the article, including SKU codes and other relevant identifiers.
raw_meta
string
Nullable
Raw metadata associated with the article, providing additional context or information.
size
string
Size of the article, which may vary for clothing, accessories, etc.
is_set
boolean
Nullable
Indicates whether the article is part of a set or collection.
tags
array of string
Nullable
Tags associated with the article for categorization and search optimization.
_custom_json
object
A custom JSON object containing additional details or configurations specific to the article.
article_details
object (ArticleStatusDetails)
Show
status
object
Nullable
Captures comprehensive status information for an article. Each status type, such as 'cancelled_fynd', contains objects keyed by unique identifiers (UIDs). These objects detail the specific status, including associated bag IDs with their quantities, total quantity affected, and reasons for the status if applicable. This structure allows for tracking multiple status conditions and their details for a single article.
bag_status
array of object (BagStatusHistory)
An array of current status records associated with the bag, reflecting its lifecycle stages (e.g., pending, placed, delivered).
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
bag_status_history
array of object (BagStatusHistory)
An array of current status records associated with the bag, reflecting its lifecycle stages (e.g., pending, placed, delivered).
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
brand
object (Brand)
Show
credit_note_expiry_days
integer
Nullable
logo
string
Nullable
invoice_prefix
string
Nullable
credit_note_allowed
boolean
Nullable
start_date
string
| date-time
Nullable
Denotes the start date and time when the brand was created.
company
string
Nullable
is_virtual_invoice
boolean
Nullable
script_last_ran
string
Nullable
pickup_location
string
Nullable
created_on
string
| date-time
Nullable
Timestamp when the brand was created.
brand_name
string
brand_id
integer
modified_on
string
| date-time
Nullable
Timestamp when the brand of the order was modified.
id
integer
Nullable
company
object (Company)
Show
pan_no
string
Nullable
created_on
string
| date-time
Nullable
Timestamp when the company was created.
id
integer
Nullable
company_name
string
Nullable
gst_number
string
Nullable
company_type
string
Nullable
The type of company, which can be one of the following:
- `distributor`: Distributor
- `franchise`: Franchise
- `mbo`: MBO (Managed Business Operations)
- `manufacturer-owner`: Owner/Manufacturer
Enum
modified_on
string
| date-time
Nullable
Timestamp when the company was modified.
meta
object
Nullable
Meta data of the company contains additional, potentially dynamic information about the company.
business_type
string
Nullable
The type of business structure, which can be one of the following:
- `Private`: Private Limited Company
- `LLP/Partnership`: Limited Liability Partnership or Partnership
- `HUF/Proprietorship`: Hindu Undivided Family or Proprietorship.
agreement_start_date
string
| date-time
Nullable
Specifies the official beginning date and time of an agreement or contract associated with the company.
current_operational_status
object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
current_status
object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
dates
object (Dates)
Show
delivery_date
string
| date-time
Nullable
Represents the scheduled date and time for the delivery of the entity.
order_created
string
Nullable
delivery_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
delivery_slot
object (DeliverySlotDetails)
Nullable
Show
slot
string
Nullable
upper_bound
string
Nullable
lower_bound
string
Nullable
date
string
Nullable
type
string
Nullable
display_name
string
Nullable
Name of the bag intended for user display.
dp_details
object
Nullable
Additional information about the delivery partner (DP) handling the bag.
einvoice_info
object
Nullable
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
fallback_user
object
Nullable
Details of the fallback user associated with the bag.
financial_breakup
array of object (FinancialBreakup)
A breakdown of the financial aspects associated with the bag, such as product prices, taxes, discounts, and total cost.
Show
refund_credit
number
The amount of refund credits applicable for the transaction.
amount_paid_roundoff
integer
Nullable
Total amount paid, rounded off to the nearest integer for billing purposes.
price_effective
number
The effective price after applying discounts and before any taxes.
promotion_effective_discount
number
The amount of discount applied from promotional offers.
transfer_price
number
The fixed selling price applicable for payouts by the brand.
coupon_effective_discount
number
The discount applied through a coupon code, if applicable.
gst_fee
number
Total Goods and Services Tax (GST) fee charged on the goods or services.
tax_collected_at_source
number
Nullable
Tax amount collected at the source of income or transaction.
brand_calculated_amount
number
Amount calculated by the brand, possibly reflecting various costs or fees.
delivery_charge
number
Fee applicable for the delivery of the goods.
gst_tag
string
A tag used to denote GST-related attributes or classifications.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods, used in trade and commerce for uniform identification across different countries.
cashback
number
The cashback amount provided to the customer, if applicable.
item_name
string
The name or description of the item related to the financial breakup.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
cashback_applied
number
The effective cashback value that has been applied to the transaction.
cod_charges
number
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
The indicated price or value assigned to an item before any discounts or adjustments.
size
string
The size of the item, if applicable.
amount_paid
number
Total amount paid by the customer for the transaction.
coupon_value
number
The effective value of the coupon used in the transaction.
discount
number
Total amount discounted from the original price of the goods.
fynd_credits
number
Credits provided by Fynd to the customer, possibly as part of a rewards program.
gst_tax_percentage
number
The percentage of GST applicable on the goods or services.
amount_to_be_collected
number
Amount to be collected in case of multiple modes of payments.
identifiers
object (Identifier)
Show
alu
string
Nullable
The ALU (Article Level Unit) code used to identify the item at a detailed level, often specific to certain retail or distribution systems.
ean
string
Nullable
The European Article Number (EAN) is a unique identifier for products, primarily used in retail and logistics. It helps in tracking and managing inventory across various platforms.
sku_code
string
Nullable
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.
upc
string
Nullable
The Universal Product Code (UPC) is a barcode symbol used for tracking trade items in stores. It is widely used in North America and helps in identifying products quickly during point-of-sale transactions.
isbn
string
Nullable
The International Standard Book Number (ISBN) is a unique identifier for books, allowing for easier management and tracking of book inventories in retail and library systems.
total_units
integer
The total number of units involved in the transaction.
added_to_fynd_cash
boolean
Indicates whether the amount has been added to Fynd cash for future use.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Represents a detailed breakdown of a specific tax component applied to a transaction or item.
This schema provides information about the type of tax, the rate at which it is applied,
the calculated tax amount, and the base amount on which the tax is computed.
name
string
The name or type of the tax component (e.g., GST, VAT, Service Tax).
This helps in identifying the specific tax being applied to the transaction or item.
rate
number
| float
The percentage rate at which the tax is applied to the taxable amount.
This value is typically represented as a decimal (e.g., 0.18 for 18% tax).
tax_amount
number
| float
The total monetary value of the tax calculated for this component.
This is derived by applying the tax rate to the taxable amount.
taxable_amount
number
| float
The base amount on which the tax is calculated, excluding the tax itself.
This represents the value of goods or services before tax is applied.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
fulfilling_store
object (Store)
Nullable
Show
phone
string
is_active
boolean
Nullable
company_id
integer
alohomora_user_id
integer
Nullable
created_at
string
| date-time
Denotes the date and time when the store was created.
contact_person
string
store_email
string
is_enabled_for_recon
boolean
Nullable
pincode
string
mall_area
string
Nullable
vat_no
string
Nullable
address1
string
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
store_active_from
string
Nullable
city
string
name
string
longitude
number
Nullable
brand_store_tags
array of string
Nullable
order_integration_id
string
Nullable
parent_store_id
integer
Nullable
location_type
string
Type of location of the fulfilling store.
Enum
code
string
Nullable
fulfillment_channel
string
updated_at
string
| date-time
Nullable
Denotes the date and time when any modifications were made to the store.
store_address_json
object (StoreAddress)
Show
phone
string
created_at
string
| date-time
Denotes the date and time when the transition of the store address was created.
contact_person
string
pincode
integer
address_type
string
The type of the address (e.g., home, office).
address1
string
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
version
string
Nullable
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
city
string
longitude
number
address2
string
area
string
Nullable
email
string
Nullable
updated_at
string
| date-time
Denotes the date and time when any modifications were made to the store.
country_code
string
Uniquely identifies the country of the store addressds_type using the two-character standard ISO 3166-1 alpha-2 country codes. Examples include 'US' for the United States and 'IN' for India.
country
string
landmark
string
latitude
number
state
string
meta
object (StoreMeta)
Show
additional_contact_details
object
Nullable
Provides a flexible structure for storing extra contact information related to the store.
timing
array of object
Nullable
notification_emails
array of string
Nullable
gst_number
string
Nullable
ewaybill_portal_details
object
Nullable
Contains essential information and settings related to the e-Way Bill portal, which is used for generating and managing e-waybills for the transportation of goods under specific tax regulations.
einvoice_portal_details
object (EInvoicePortalDetails)
Show
username
string
Nullable
user
string
Nullable
password
string
Nullable
gst_credentials
object (StoreGstCredentials)
Show
e_invoice
object (StoreEinvoice)
Show
username
string
Nullable
user
string
Nullable
password
string
Nullable
enabled
boolean
e_waybill
object (StoreEwaybill)
Show
enabled
boolean
Nullable
stage
string
product_return_config
object
Nullable
Product return configuration details for the location. It can include details like on_same_store denoting whether return can be initiated at the same store.
documents
object (StoreDocuments)
Show
gst
object (Document)
Show
value
string
type
string
Type of the document.
verified
boolean
legal_name
string
url
string
Nullable
display_name
string
s_id
string
Nullable
state
string
country
string
packaging_material_count
integer
Nullable
is_archived
boolean
Nullable
login_username
string
Nullable
mall_name
string
Nullable
latitude
number
Nullable
address2
string
Nullable
fyndstore_emp
object
Nullable
Fynd store employee details.
gst_details
object (GSTDetailsData)
Show
cgst_tax_percentage
number
Nullable
The percentage of Central Goods and Services Tax (CGST) applicable on the goods or services.
gstin_code
string
Nullable
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.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
gst_fee
number
The total GST fee charged on the goods or services.
igst_tax_percentage
number
Nullable
The percentage of Integrated Goods and Services Tax (IGST) applicable for inter-state transactions.
gst_tax_percentage
number
Nullable
The overall GST tax percentage applicable to the goods or services.
hsn_code_id
string
Nullable
Unique identifier for the Harmonized System of Nomenclature (HSN) code used to classify goods.
igst_gst_fee
number
Nullable
The GST fee applicable for IGST, usually for inter-state transactions.
is_default_hsn_code
boolean
Nullable
Indicates whether this HSN code is the default classification for the goods.
sgst_gst_fee
number
Nullable
The GST fee applicable for State Goods and Services Tax (SGST).
tax_collected_at_source
number
Tax amount collected at the source of income or transaction, often for compliance and revenue tracking.
brand_calculated_amount
number
Amount calculated by the brand, potentially reflecting costs, fees, or pricing structures.
cgst_gst_fee
number
Nullable
The GST fee applicable for CGST.
gst_tag
string
Nullable
A tag or label used to denote GST-related attributes or classifications.
sgst_tax_percentage
number
Nullable
The percentage of State Goods and Services Tax (SGST) applicable on the goods or services.
hsn_code
string
Nullable
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.
invoice
object (InvoiceDetails)
Nullable
Show
updated_date
string
| date-time
Nullable
Specifies the date and time when the invoice was last updated.
store_invoice_id
string
Nullable
invoice_url
string
Nullable
label_url
string
Nullable
item
object (Item)
Show
attributes
object
A dictionary of product attributes
brand_id
integer
slug_key
string
webstore_product_url
string
Nullable
l3_category
integer
Nullable
Represents the product's classification at the third level in the e-commerce platform's category hierarchy, using an integer identifier. This finer level of categorization allows for precise product organization and easier navigation for customers seeking specific items.
l3_category_name
string
Nullable
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.
last_updated_at
string
| date-time
Nullable
Denotes the date and time when the item was updated.
name
string
l2_category
array of string
Nullable
The l2_category field represents the second level of categorization for items within an e-commerce platform's hierarchy. This allows for classification beyond the top-tier (level 1) categories, helping customers to narrow down their search and find products
brand
string
image
array of string
code
string
Nullable
l1_category_id
integer
Nullable
The unique identifier of the defines the top-tier categories to which a product belongs within the e-commerce platform's hierarchy.
item_id
integer
l1_category
array of string
Nullable
This array defines the top-tier categories to which a product belongs within the e-commerce platform's hierarchy.
gender
string
Nullable
can_cancel
boolean
Nullable
can_return
boolean
Nullable
size
string
branch_url
string
Nullable
meta
object
Nullable
Meta data of the item contains additional, potentially dynamic information about the item.
color
string
Nullable
department_id
integer
Nullable
l2_category_id
integer
Nullable
journey_type
string
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
line_number
integer
A unique identifying number associated with the bag. It is generated sequentially as bags are created.
lock_status
boolean
Nullable
Indicates whether the bag is locked from further changes (true/false). A locked bag cannot undergo modifications until unlocked.
manifest_id
string
Nullable
The identifier-assigned bags receive after they are manifest (thereby creating a shipment in conjunction with the allocated manifest).
meta
object
Meta data of the bag details contains additional, potentially dynamic information about the bag details.
mode_of_payment
string
Nullable
This field reflects the payment method used in the transaction for a particular bag.
no_of_bags_order
integer
Nullable
The total number of bags in this bag's order.
operational_status
string
Nullable
The particular state a bag occupies in the shipment life-cycle.
order
object (OrderDetails)
Show
fynd_order_id
string
created_at
string
| date-time
Date and time when the order was created.
user_id
string
Nullable
tax_details
object (TaxDetails)
Show
pan_no
string
Nullable
gstin
string
Nullable
mongo_cart_id
number
Nullable
delivery_charges
number
Nullable
transaction_id
string
Nullable
collect_by
string
headers
object
Nullable
Header details of the order.
coupon_value
number
Nullable
order_value
number
created_time
string
currency
string
The currency in which the prices details associated with the item is specified.
total_order_value
number
ordering_channel
string
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
meta
object
Nullable
Meta data of the order data contains additional, potentially dynamic information about the order data.
cod_charges
number
Nullable
cashback_value
number
Nullable
refund_by
string
affiliate_order_date
string
| date-time
Nullable
Specifies the date and time of the order when it was created within the affiliate's system. It specifies that the date and time are recorded in ISO 8601 format.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. The structure is designed to accommodate any number of payment methods,providing flexibility and comprehensive insights into each transaction's payment aspect.
affiliate_order_id
string
payment_mode_id
number
Nullable
promotion_effective_discount
number
Nullable
mode_of_payment
string
discount
number
Nullable
cashback_applied
number
Nullable
fynd_credits
number
Nullable
affiliate_id
string
ordering_channel_logo
string
Nullable
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
loyalty_discount_details
object (LoyaltyDiscountDetails)
Show
Object containing detailed information about the loyalty discount applied during an order.
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed.
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace.
Enum
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order.
order_integration_id
string
Nullable
A unique identifier used for integrating this order with external systems or services.
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
order_value
number
Nullable
An estimated value of the order at the time of placement or sale.
ordering_store
object (Store)
Nullable
Show
phone
string
is_active
boolean
Nullable
company_id
integer
alohomora_user_id
integer
Nullable
created_at
string
| date-time
Denotes the date and time when the store was created.
contact_person
string
store_email
string
is_enabled_for_recon
boolean
Nullable
pincode
string
mall_area
string
Nullable
vat_no
string
Nullable
address1
string
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
store_active_from
string
Nullable
city
string
name
string
longitude
number
Nullable
brand_store_tags
array of string
Nullable
order_integration_id
string
Nullable
parent_store_id
integer
Nullable
location_type
string
Type of location of the fulfilling store.
Enum
code
string
Nullable
fulfillment_channel
string
updated_at
string
| date-time
Nullable
Denotes the date and time when any modifications were made to the store.
store_address_json
object (StoreAddress)
Show
phone
string
created_at
string
| date-time
Denotes the date and time when the transition of the store address was created.
contact_person
string
pincode
integer
address_type
string
The type of the address (e.g., home, office).
address1
string
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
version
string
Nullable
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
city
string
longitude
number
address2
string
area
string
Nullable
email
string
Nullable
updated_at
string
| date-time
Denotes the date and time when any modifications were made to the store.
country_code
string
Uniquely identifies the country of the store addressds_type using the two-character standard ISO 3166-1 alpha-2 country codes. Examples include 'US' for the United States and 'IN' for India.
country
string
landmark
string
latitude
number
state
string
meta
object (StoreMeta)
Show
additional_contact_details
object
Nullable
Provides a flexible structure for storing extra contact information related to the store.
timing
array of object
Nullable
notification_emails
array of string
Nullable
gst_number
string
Nullable
ewaybill_portal_details
object
Nullable
Contains essential information and settings related to the e-Way Bill portal, which is used for generating and managing e-waybills for the transportation of goods under specific tax regulations.
einvoice_portal_details
object (EInvoicePortalDetails)
Show
username
string
Nullable
user
string
Nullable
password
string
Nullable
gst_credentials
object (StoreGstCredentials)
Show
e_invoice
object (StoreEinvoice)
Show
username
string
Nullable
user
string
Nullable
password
string
Nullable
enabled
boolean
e_waybill
object (StoreEwaybill)
Show
enabled
boolean
Nullable
stage
string
product_return_config
object
Nullable
Product return configuration details for the location. It can include details like on_same_store denoting whether return can be initiated at the same store.
documents
object (StoreDocuments)
Show
gst
object (Document)
Show
value
string
type
string
Type of the document.
verified
boolean
legal_name
string
url
string
Nullable
display_name
string
s_id
string
Nullable
state
string
country
string
packaging_material_count
integer
Nullable
is_archived
boolean
Nullable
login_username
string
Nullable
mall_name
string
Nullable
latitude
number
Nullable
address2
string
Nullable
parent_promo_bags
object
Nullable
An object containing details of parent promotional bags.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. The structure is designed to accommodate any number of payment methods,providing flexibility and comprehensive insights into each transaction's payment aspect.
payment_type
string
Nullable
The Specific type of payment.
Enum
payments
object
Nullable
Defines allowed payment details for the item.
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Defines any additional charges for the product.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
qc_required
boolean
Nullable
Indicates whether quality check is required for the product.
quantity
number
Nullable
The quantity of the product.
reasons
array of object
Nullable
Information about why the Bag's item/products are being cancelled or returned or exchanged. This keys within this object represent unique
restore_coupon
boolean
Nullable
Indicates whether voucher/wallet points can be reapplied to the product.
restore_promos
object
Nullable
Provides a flexible structure for storing information about promotion details or offers that are eligible for restoration. This can include details such as promo codes, descriptions of the offers, eligibility criteria, restoration conditions, and any other relevant data that supports the reactivation of previously paused or expired promotions.
rto_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
seller_identifier
string
Nullable
A unique identifier assigned by the seller to represent a specific transaction in their order processing system.
shipment
object (Shipment)
Show
line_items
array of object (LineItem)
An array of objects that represent the items included in the shipment.
Show
charges
array of object (Charge)
An array of Charge objects related to the line item. This array must include three mandatory charge types: amount_paid, price_effective and price_marked. Formula to calculate amount_paid = price_effective + cod_charges + delivery_charges - coupon_discount - promo_discount
Show
amount
object (AmountSchema)
Show
The monetary value of the charge, including value and currency details.
currency
string
The value indicating the currency used for the transactions.
value
number
The final amount of the charge.
type
string
The category or type of the charge.
name
string
The name of the charge that indicates its purpose.
code
string
An optional code associated with the charge for internal tracking.
tax
object (Tax)
Show
name
string
The name of the tax indicating its purpose (e.g., VAT, sales tax).
rate
number
| float
The tax rate as a decimal, applied to the transaction amount.
breakup
array of object
An array of objects detailing the components or breakdown of the tax applied.
amount
object
An object representing the total tax amount calculated for the transaction.
meta
object
An object containing metadata relevant to articles or line items.
custom_message
string
A string for any special instructions or messages related to the line item.
quantity
integer
| int32
Quantity of the articles or line items.
seller_identifier
string
Unique identifier of the articles or line items set by seller.
external_line_id
string
External unique identifier of the articles or line items.
external_shipment_id
string
External shipment identifier or marketplace's unique shipment identifier.
processing_dates
object (ProcessingDates)
Show
dp_pickup_slot
object
An object that provides details about the designated pickup time slot for the order.
dispatch_after_date
string
A string indicating the date after which the order will be dispatched.
dispatch_by_date
string
A string representing the latest date by which the order must be dispatched to meet delivery expectations.
confirm_by_date
string
A string that indicates the deadline for the merchant to confirm the order.
customer_pickup_slot
object
An object that provides details of the pick-up time slot set by the customer.
pack_by_date
string
| date-time
Defines the deadline for having the package fully packed and ready for dispatch or pickup, integral to streamlining the fulfillment process.
meta
object
Nullable
Meta data of the shipment contains additional, potentially dynamic information about the shipment.
priority
integer
| int32
Priority level of the shipment.
location_id
integer
| int32
Location/store/fulfillment identifier of the shipment. This field is mandatory when optimal_shipment_creation flag is set to false, indicating that shipments must be associated with a specific location. When optimal_shipment_creation is true, location_id becomes optional and the system automatically assigns the optimal location for order creation.
order_type
string
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 undergoes all state transitions typical for a delivery, from processing the shipment to final delivery at the customer's address.
"PickAtStore": The order is prepared for pickup and moved to a state where it is ready to be handed over directly to the customer at the store. This type streamlines the process by bypassing traditional shipping stages and facilitating a quicker transition to the final handover stage.
"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
tags
array of object (Tag)
Nullable
Show
Tag provides a way to categorize or label shipment for easier identification, filtering, or tracking.
slug
string
A unique identifier or short label for the tag for shipment reference.
display_text
string
Label of the tag. This text is shown to users, representing the tag in an human-readable format.
system_messages
array of object (SystemMessages)
Show
Shows messages at Fynd Commerce's Order Details
message_type
string
Specifies the type of message.
Enum
priority
number
This will determine the sequence of messages (1 being the highest priority).
message
string
Message to be displayed at Platform's Order Details.
inject_at
array of string
Holds the list of OMS status at which the message should be visible.
process_after_config
object (ProcessAfterConfig)
Show
Configuration to override the default shipment processing behavior, allowing the shipment to be processed after a specified interval.
is_scheduled_shipment
boolean
Indicates whether the shipment is scheduled for later processing.
enable_processing_after
string
| date-time
Specifies the UTC time after which the shipment will be automatically processed.
parent_type
string
Nullable
store_invoice_id
string
Nullable
lock_status
string
Nullable
type
string
Nullable
billing_address_json
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
id
string
fulfilment_priority
integer
Nullable
is_active
boolean
previous_shipment_id
string
Nullable
pdf_links
object
Nullable
PDF Links associated with the shipment.
delivery_address_json
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
eway_bill_id
string
Nullable
affiliate_shipment_id
string
Nullable
fynd_order_id
string
created_at
string
| date-time
Specifies the date and time when the shipment was created.
delivery_awb_number
string
Nullable
hand_over_contact_json
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
credit_note_id
string
Nullable
parent_id
string
Nullable
affiliate_id
string
packaging_type
string
Nullable
Defines the type of packaging used for the product, encompassing materials, design, and form factors.
vertical
string
Nullable
quantity
number
Nullable
status
object (ShipmentStatusData)
Show
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
bag_list
array of string
Nullable
The list of bags that are in this shipment status transition.
id
integer
Nullable
Unique identifier for a shipment status.
created_at
string
| date-time
Nullable
Denotes the date and time when the transition was created.
created_ts
string
Nullable
A timestamp indicating when the status entry was created.
shipment_id
string
Nullable
The unique identifier for the shipment.
status
string
Nullable
The current status of the shipment.
display_name
string
Nullable
A user-friendly name or description of the current shipment status.
current_shipment_status
string
Nullable
Reflects the most recent status of the shipment.
status_created_at
string
| date-time
Nullable
Denotes the date and time when the transition of the status of the shipment was created.
price
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
gst
object (ShipmentGstDetails)
Nullable
Show
value_of_good
number
Nullable
gst_fee
number
Nullable
brand_calculated_amount
number
Nullable
tax_collected_at_source
number
Nullable
gstin_code
string
Nullable
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.
shipment_details
object (ShipmentDetails)
Nullable
Show
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
shipments
integer
| int32
fulfillment_id
integer
| int32
articles
array of object (ArticleDetails)
Show
_id
string
A unique identifier for the article, facilitating easy reference and management within the system.
brand_id
integer
| int32
Numerical code representing the brand associated with the article, linking it to its manufacturer or creator.
dimension
object
Specifies the physical dimensions of the article, including height, width, and depth, providing a comprehensive understanding of its size.
category
object
Classifies the article into a specific category or type, aiding in organization and filtering based on its nature or usecase.
weight
object
Details the weight of the article, crucial for logistics, shipping calculations, and customer information.
attributes
object
Holds additional descriptive details and characteristics of the article, such as color, material, and style, enhancing product understanding.
quantity
integer
| int32
Specifies the available or required quantity of the article, important for inventory management and order fulfillment.
dp_id
string
| int32
Nullable
meta
object
affiliate_shipment_id
string
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment.
lock_status
boolean
Nullable
action_to_status
object
Nullable
This field maps potential actions (e.g., downloading an invoice or label) to their corresponding shipment lock statuses, indicating which operations are allowed depending on the shipment's current lock status. When an action is set to 'lock', it means no transitions or updates to the shipment's status can be performed until the specified action is completed. For instance, if 'download_invoice' is in a 'lock' state, the shipment cannot undergo any status transitions until the invoice is either downloaded. Similarly, 'download_label' being in a 'lock' state prevents any shipment status transitions until a new label is downloaded.
shipment_id
string
Nullable
Unique identifier of the shipment.
shipment_gst
object (ShipmentGstDetails)
Nullable
Show
value_of_good
number
Nullable
gst_fee
number
Nullable
brand_calculated_amount
number
Nullable
tax_collected_at_source
number
Nullable
gstin_code
string
Nullable
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.
shipment_status
object (ShipmentStatusData)
Show
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
bag_list
array of string
Nullable
The list of bags that are in this shipment status transition.
id
integer
Nullable
Unique identifier for a shipment status.
created_at
string
| date-time
Nullable
Denotes the date and time when the transition was created.
created_ts
string
Nullable
A timestamp indicating when the status entry was created.
shipment_id
string
Nullable
The unique identifier for the shipment.
status
string
Nullable
The current status of the shipment.
display_name
string
Nullable
A user-friendly name or description of the current shipment status.
current_shipment_status
string
Nullable
Reflects the most recent status of the shipment.
status_created_at
string
| date-time
Nullable
Denotes the date and time when the transition of the status of the shipment was created.
shipment_status_history
array of object (ShipmentStatusData)
Nullable
Status history of the shipment item in the order.
Show
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
bag_list
array of string
Nullable
The list of bags that are in this shipment status transition.
id
integer
Nullable
Unique identifier for a shipment status.
created_at
string
| date-time
Nullable
Denotes the date and time when the transition was created.
created_ts
string
Nullable
A timestamp indicating when the status entry was created.
shipment_id
string
Nullable
The unique identifier for the shipment.
status
string
Nullable
The current status of the shipment.
display_name
string
Nullable
A user-friendly name or description of the current shipment status.
current_shipment_status
string
Nullable
Reflects the most recent status of the shipment.
status_created_at
string
| date-time
Nullable
Denotes the date and time when the transition of the status of the shipment was created.
status
object (BagReturnableCancelableStatus)
Show
is_returnable
boolean
Indicates whether the bag can be returned by the customer.
is_active
boolean
Specifies if the current status of the bag is active, affecting its eligibility for return or cancellation.
can_be_cancelled
boolean
Indicates if the bag order can be cancelled by the customer.
enable_tracking
boolean
Indicates whether tracking is enabled for the bag, allowing customers to monitor its status.
is_customer_return_allowed
boolean
Specifies if the customer is permitted to return the bag, based on the return policy.
tags
array of string
Nullable
A list of tags or labels associated with the bag, which might be used for filtering, sorting, or categorizing purposes.
total_shipment_bags
integer
Nullable
The total number of shipped bags.
total_shipments_in_order
integer
Nullable
The total number of shipments in the order.
transaction_type
string
Nullable
Specifies the type of the transaction being processed. This classification helps in distinguishing between different operational processes and allows for tailored handling of each transaction type. For example, a 'shipment' transaction type refers to operations related to the shipping of goods.
Enum
type
string
Nullable
The type of the bag.
updated_at
string
| date-time
Nullable
The date and time when the bag was last updated.
user
object (UserDetails)
Nullable
Show
user_oid
string
Nullable
external_customer_id
string
Nullable
first_name
string
Nullable
last_name
string
Nullable
mobile
string
Nullable
email
string
Nullable
is_anonymous_user
boolean
Nullable
gender
string
Nullable
mongo_user_id
string
Nullable
meta
object
Nullable
Meta data of the user details contains additional, potentially dynamic information about the user details.
weight
object (WeightData)
Nullable
Show
value
number
Nullable
unit
string
Nullable
original_bag_list
array of integer
Nullable
Specifies the list of integers that specify the bag number
identifier
string
Nullable
The unique identifier for the bag.
Examples
Parameters
company_id:
1
bag_id:
"value"
channel_bag_id:
"value"
channel_id:
"value"
Response
Get bag
getBagById
Parameters
company_idpath
integer
Required
Id of company
bag_idsquery
string
Comma separated values of bag ids
shipment_idsquery
string
Comma separated values of shipment ids
order_idsquery
string
Comma separated values of order ids
channel_bag_idsquery
string
Comma separated values of app bag ids
channel_shipment_idsquery
string
Comma separated values of app shipment ids
channel_order_idsquery
string
Comma separated values of app order ids
channel_idquery
string
Comma separated values of app ids
page_noquery
integer
Page number for paginated data
Default Value : 1
page_sizequery
integer
Page size of data received per page
Default Value : 20
GET
Response
200
Successfully retrived all the given shipments details!
Hide
status_code
integer
Response status_code.
Enum
data
object (BagData)
Nullable
Show
items
array of object (BagDetails)
Show
bag_update_time
number
Nullable
The timestamp indicating when the bag's information was last updated
id
string
Nullable
A unique identifier for the bag record within the system.
bag_id
integer
Nullable
A unique identifier specifically for the bag itself, used for tracking purposes.
affiliate_bag_details
object (AffiliateBagDetails)
Show
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_order_id
string
Unique identifier for the affiliate order associated with the bag.
employee_discount
number
Nullable
Discount percentage or amount applicable to employees for this order.
affiliate_bag_id
string
Unique identifier for the affiliate bag, used for tracking and reference.
loyalty_discount
number
| float
Discount amount applied based on customer loyalty, if applicable.
affiliate_details
object (AffiliateDetails)
Show
Details of an affiliate associated with a shipment.
shipment_meta
object (ShipmentMeta)
Show
tracking_url
string
Nullable
A URL for tracking the shipment.
estimated_delivery_date
string
| date-time
Nullable
Provides a forecasted date and time by which the shipment is expected to be delivered to the recipient. This estimation is crucial for planning purposes, both for the sender in managing expectations and for the recipient in preparing for receipt.
same_store_available
boolean
Indicates whether the shipment is available for pickup from the same store.
b2b_buyer_details
object (BuyerDetails)
Show
ajio_site_id
string
Nullable
The unique identifier for the buyer on the Ajio platform.
pincode
integer
The postal code for the buyer's shipping address, used for delivery location identification.
address
string
Provides the comprehensive address details of the buyer's shipping address.
gstin
string
The Goods and Services Tax Identification Number (GSTIN) of the buyer.
name
string
The full name of the buyer, essential for personalizing communication and delivery.
state
string
The name of the state where the buyer's shipping address is located, important for logistical purposes.
city
string
The name of the city where the buyer's shipping address is located, which helps in identifying delivery zones.
formatted
object (Formatted)
Show
max
string
Nullable
Represents the maximum formatted value, providing a limit for the associated data, such as dimensions or weights.
min
string
Nullable
Represents the minimum formatted value, establishing a lower limit for the associated data, ensuring it meets certain criteria or standards.
debug_info
object (DebugInfo)
Show
stormbreaker_uuid
string
Nullable
A unique identifier (UUID) associated with the Stormbreaker system, used for tracking and debugging purposes in the application.
return_awb_number
string
Nullable
The Air Waybill (AWB) number associated with a return shipment.
is_self_ship
boolean
Nullable
Indicates whether the shipment is a self-shipped order.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
einvoice_info
object (EinvoiceInfo)
Show
credit_note
object
Nullable
Specifies the reverse einvoice transaction create on government portal.
invoice
object
Nullable
It specifies the forward einvoice transaction created on government portal.
return_affiliate_shipment_id
string
Nullable
The shipment ID associated with a return from an affiliate.
parent_dp_id
string
Nullable
The unique identifier for the parent delivery partner.
shipment_weight
number
Nullable
The total weight of the shipment.
dimension
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment.
assign_dp_from_sb
boolean
Nullable
Indicates whether to assign the delivery partner from the store’s basket.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
store_invoice_updated_date
string
| date-time
Nullable
Denotes the date and time when the store's invoice related to this shipment was updated. This timestamp is vital for tracking changes to billing details, adjustments in charges, or updates in the invoicing status.
forward_affiliate_shipment_id
string
Nullable
The shipment ID for the forward journey of an affiliate shipment.
return_store_node
integer
Nullable
The identifier for the store node involved in the return process.
fulfilment_priority_text
string
Nullable
Textual representation of the fulfillment priority for the shipment.
shipment_tags
array of object (ShipmentTags)
Tags associated with the shipment for categorization and filtering.
Show
slug
string
Nullable
A URL-friendly string representing the tag, often used for routing or categorization.
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
display_text
string
Nullable
A human-readable text representation of the tag, used for display purposes in user interfaces.
external
object
Nullable
External metadata related to the shipment.
awb_number
string
Nullable
The Air Waybill number associated with the shipment.
lock_data
object (LockData)
Show
locked
boolean
Nullable
Indicates whether the shipment is currently locked for processing (true) or not (false).
mto
boolean
Nullable
A flag indicating whether the shipment is part of a multi-modal transport operation.
lock_message
string
Nullable
An optional message providing additional context or information regarding the lock status.
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.
Enum
ewaybill_info
object
Nullable
Electronic Way Bill details i.e ewayBillNo, ewayBillDate that are utilized in the transportation of goods.
dp_id
string
Nullable
The unique identifier for the delivery partner associated with the shipment.
shipment_volumetric_weight
number
Nullable
The volumetric weight of the shipment, which may differ from its actual weight.
marketplace_store_id
string
Nullable
The unique identifier for the marketplace store associated with the shipment.
return_details
object
Nullable
An object containing the return details of the shipment.
dp_sort_key
string
Nullable
A sort key for the delivery partner, used for prioritization.
packaging_name
string
Nullable
The name of the packaging used for the shipment.
timestamp
object (ShipmentTimeStamp)
Show
max
integer
Nullable
Represents the maximum timestamp value, indicating the latest time relevant to the shipment.
min
integer
Nullable
Represents the minimum timestamp value, indicating the earliest time relevant to the shipment.
auto_trigger_dp_assignment_acf
boolean
Nullable
Indicates whether automatic delivery partner assignment is triggered for this shipment.
dp_name
string
Nullable
The name of the delivery partner associated with the shipment.
po_number
string
Nullable
The purchase order number associated with the shipment.
weight
integer
The weight of the shipment, typically measured in grams or kilograms.
b2c_buyer_details
object
Nullable
Contains detailed information about the buyer in a business-to-consumer (B2C) transaction. This object is designed to capture a wide array of buyer-specific data such as contact information, shipping address, preferences, and any other relevant details that enhance the understanding of the buyer's profile and needs.
forward_affiliate_order_id
string
Nullable
The order ID for the forward journey of an affiliate shipment.
return_affiliate_order_id
string
Nullable
The order ID for the return journey of an affiliate shipment.
bag_weight
object
Nullable
This object is designed to accommodate a range of weight-related information. Denotes the weight of the bag, potentially including various measurements or related details.
refund_to
string
Nullable
Specifies the recipient of any refunds related to the shipment.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_shipment_id
string
The shipment ID specific to this affiliate.
company_affiliate_tag
string
Nullable
An optional tag representing the company's affiliate association.
affiliate_order_id
string
The order ID associated with the affiliate shipment.
pdf_links
object (PDFLinks)
Show
invoice_type
string
The type of invoice issued, such as 'fynd' or other classifications.
Enum
label_a6
string
Nullable
URL or path to the A6 size label document.
invoice
string
Nullable
URL or path to the main invoice document.
label_pos
string
Nullable
URL or path to the POS label document.
invoice_a6
string
Nullable
URL or path to the A6 size invoice document.
b2b
string
Nullable
URL or path to the B2B document related to the transaction.
label
string
Nullable
URL or path to the general label document.
label_a4
string
Nullable
URL or path to the A4 size label document.
label_type
string
Specifies the type of label associated with a PDF document,indicating its purpose or content. The label_type helps in organizing and identifying PDF documents quickly, ensuring that users or systems can efficiently utilize the correct documents for required actions.
Enum
invoice_export
string
Nullable
URL or path to the exported invoice document.
credit_note_url
string
Nullable
URL or path to the credit note document.
delivery_challan_a4
string
Nullable
URL or path to the A4 delivery challan document.
label_export
string
Nullable
URL or path to the exported label document.
invoice_a4
string
Nullable
URL or path to the A4 size invoice document.
invoice_pos
string
Nullable
URL or path to the POS invoice document.
po_invoice
string
Nullable
URL or path to the purchase order invoice document.
config
object (AffiliateConfig)
Show
app
object (AffiliateAppConfig)
Show
id
string
description
string
updated_at
string
| date-time
The date and time when the app config was updated.
name
string
token
string
meta
array of object (AffiliateAppConfigMeta)
Show
value
string
name
string
owner
string
secret
string
created_at
string
| date-time
Timestamp when the app config was created.
inventory
object (AffiliateInventoryConfig)
Show
article_assignment
object (AffiliateInventoryArticleAssignmentConfig)
Show
post_order_reassignment
boolean
payment
object (AffiliateInventoryPaymentConfig)
Show
source
string
mode_of_payment
string
inventory
object (AffiliateInventoryStoreConfig)
Show
store
object
Fulfilling store information related to the shipment.
order
object (AffiliateInventoryOrderConfig)
Show
force_reassignment
boolean
logistics
object (AffiliateInventoryLogisticsConfig)
Show
dp_assignment
boolean
app_company_id
integer
Nullable
A unique identifier for the company associated with the affiliate app, used for tracking and managing affiliate relationships.
affiliate_id
string
Nullable
The unique identifier for the affiliate.
affiliate_store_id
string
The unique identifier for the affiliate's store.
affiliate_bag_id
string
The unique identifier for the affiliate's bag.
id
string
Nullable
The unique identifier for the affiliate.
applied_promos
array of object
Nullable
A list of promotional discounts that were applied to the bag's contents.
article
object (Article)
Show
seller_identifier
string
Unique identifier assigned by the seller to the article, used for inventory management.
uid
string
A unique identifier for the article within the system.
set
object
Nullable
Represents the data related to combinations of articles that, while being the same product, vary by size, color, or other distinguishing features.
dimensions
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
currency
object
Nullable
Currency in which the transaction amount associated with the article is specified.
esp_modified
boolean
Nullable
Indicates whether the article has been modified by the ESP (e-commerce service provider).
return_config
object (ReturnConfig)
Nullable
Configuration related to the return policy for the article.
Show
returnable
boolean
Nullable
Indicates whether the article is eligible for return, allowing customers to send it back under specified conditions.
time
number
Nullable
The time frame within which the return must be initiated, typically measured in days.
unit
string
Nullable
The unit of time for the return period (e.g., days, weeks).
code
string
Nullable
Internal code or identifier for the article, used for reference.
weight
object (Weight)
Show
is_default
boolean
Nullable
Indicates whether this weight value is the default weight used for the article.
shipping
integer
Nullable
The weight of the article specifically for shipping purposes, usually measured in grams or kilograms.
unit
string
Nullable
The unit of measurement for the weight (e.g., grams, kilograms, pounds).
_id
string
The unique identifier for the article within the database.
identifiers
object
Details of identifiers associated with the article, including SKU codes and other relevant identifiers.
raw_meta
string
Nullable
Raw metadata associated with the article, providing additional context or information.
size
string
Size of the article, which may vary for clothing, accessories, etc.
is_set
boolean
Nullable
Indicates whether the article is part of a set or collection.
tags
array of string
Nullable
Tags associated with the article for categorization and search optimization.
_custom_json
object
A custom JSON object containing additional details or configurations specific to the article.
article_details
object (ArticleStatusDetails)
Show
status
object
Nullable
Captures comprehensive status information for an article. Each status type, such as 'cancelled_fynd', contains objects keyed by unique identifiers (UIDs). These objects detail the specific status, including associated bag IDs with their quantities, total quantity affected, and reasons for the status if applicable. This structure allows for tracking multiple status conditions and their details for a single article.
bag_status
array of object (BagStatusHistory)
An array of current status records associated with the bag, reflecting its lifecycle stages (e.g., pending, placed, delivered).
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
bag_status_history
array of object (BagStatusHistory)
An array of current status records associated with the bag, reflecting its lifecycle stages (e.g., pending, placed, delivered).
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
brand
object (Brand)
Show
credit_note_expiry_days
integer
Nullable
logo
string
Nullable
invoice_prefix
string
Nullable
credit_note_allowed
boolean
Nullable
start_date
string
| date-time
Nullable
Denotes the start date and time when the brand was created.
company
string
Nullable
is_virtual_invoice
boolean
Nullable
script_last_ran
string
Nullable
pickup_location
string
Nullable
created_on
string
| date-time
Nullable
Timestamp when the brand was created.
brand_name
string
brand_id
integer
modified_on
string
| date-time
Nullable
Timestamp when the brand of the order was modified.
id
integer
Nullable
company
object (Company)
Show
pan_no
string
Nullable
created_on
string
| date-time
Nullable
Timestamp when the company was created.
id
integer
Nullable
company_name
string
Nullable
gst_number
string
Nullable
company_type
string
Nullable
The type of company, which can be one of the following:
- `distributor`: Distributor
- `franchise`: Franchise
- `mbo`: MBO (Managed Business Operations)
- `manufacturer-owner`: Owner/Manufacturer
Enum
modified_on
string
| date-time
Nullable
Timestamp when the company was modified.
meta
object
Nullable
Meta data of the company contains additional, potentially dynamic information about the company.
business_type
string
Nullable
The type of business structure, which can be one of the following:
- `Private`: Private Limited Company
- `LLP/Partnership`: Limited Liability Partnership or Partnership
- `HUF/Proprietorship`: Hindu Undivided Family or Proprietorship.
agreement_start_date
string
| date-time
Nullable
Specifies the official beginning date and time of an agreement or contract associated with the company.
current_operational_status
object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
current_status
object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
dates
object (Dates)
Show
delivery_date
string
| date-time
Nullable
Represents the scheduled date and time for the delivery of the entity.
order_created
string
Nullable
delivery_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
delivery_slot
object (DeliverySlotDetails)
Nullable
Show
slot
string
Nullable
upper_bound
string
Nullable
lower_bound
string
Nullable
date
string
Nullable
type
string
Nullable
display_name
string
Nullable
Name of the bag intended for user display.
dp_details
object
Nullable
Additional information about the delivery partner (DP) handling the bag.
einvoice_info
object
Nullable
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
fallback_user
object
Nullable
Details of the fallback user associated with the bag.
financial_breakup
array of object (FinancialBreakup)
A breakdown of the financial aspects associated with the bag, such as product prices, taxes, discounts, and total cost.
Show
refund_credit
number
The amount of refund credits applicable for the transaction.
amount_paid_roundoff
integer
Nullable
Total amount paid, rounded off to the nearest integer for billing purposes.
price_effective
number
The effective price after applying discounts and before any taxes.
promotion_effective_discount
number
The amount of discount applied from promotional offers.
transfer_price
number
The fixed selling price applicable for payouts by the brand.
coupon_effective_discount
number
The discount applied through a coupon code, if applicable.
gst_fee
number
Total Goods and Services Tax (GST) fee charged on the goods or services.
tax_collected_at_source
number
Nullable
Tax amount collected at the source of income or transaction.
brand_calculated_amount
number
Amount calculated by the brand, possibly reflecting various costs or fees.
delivery_charge
number
Fee applicable for the delivery of the goods.
gst_tag
string
A tag used to denote GST-related attributes or classifications.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods, used in trade and commerce for uniform identification across different countries.
cashback
number
The cashback amount provided to the customer, if applicable.
item_name
string
The name or description of the item related to the financial breakup.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
cashback_applied
number
The effective cashback value that has been applied to the transaction.
cod_charges
number
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
The indicated price or value assigned to an item before any discounts or adjustments.
size
string
The size of the item, if applicable.
amount_paid
number
Total amount paid by the customer for the transaction.
coupon_value
number
The effective value of the coupon used in the transaction.
discount
number
Total amount discounted from the original price of the goods.
fynd_credits
number
Credits provided by Fynd to the customer, possibly as part of a rewards program.
gst_tax_percentage
number
The percentage of GST applicable on the goods or services.
amount_to_be_collected
number
Amount to be collected in case of multiple modes of payments.
identifiers
object (Identifier)
Show
alu
string
Nullable
The ALU (Article Level Unit) code used to identify the item at a detailed level, often specific to certain retail or distribution systems.
ean
string
Nullable
The European Article Number (EAN) is a unique identifier for products, primarily used in retail and logistics. It helps in tracking and managing inventory across various platforms.
sku_code
string
Nullable
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.
upc
string
Nullable
The Universal Product Code (UPC) is a barcode symbol used for tracking trade items in stores. It is widely used in North America and helps in identifying products quickly during point-of-sale transactions.
isbn
string
Nullable
The International Standard Book Number (ISBN) is a unique identifier for books, allowing for easier management and tracking of book inventories in retail and library systems.
total_units
integer
The total number of units involved in the transaction.
added_to_fynd_cash
boolean
Indicates whether the amount has been added to Fynd cash for future use.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Represents a detailed breakdown of a specific tax component applied to a transaction or item.
This schema provides information about the type of tax, the rate at which it is applied,
the calculated tax amount, and the base amount on which the tax is computed.
name
string
The name or type of the tax component (e.g., GST, VAT, Service Tax).
This helps in identifying the specific tax being applied to the transaction or item.
rate
number
| float
The percentage rate at which the tax is applied to the taxable amount.
This value is typically represented as a decimal (e.g., 0.18 for 18% tax).
tax_amount
number
| float
The total monetary value of the tax calculated for this component.
This is derived by applying the tax rate to the taxable amount.
taxable_amount
number
| float
The base amount on which the tax is calculated, excluding the tax itself.
This represents the value of goods or services before tax is applied.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
fulfilling_store
object (Store)
Nullable
Show
phone
string
is_active
boolean
Nullable
company_id
integer
alohomora_user_id
integer
Nullable
created_at
string
| date-time
Denotes the date and time when the store was created.
contact_person
string
store_email
string
is_enabled_for_recon
boolean
Nullable
pincode
string
mall_area
string
Nullable
vat_no
string
Nullable
address1
string
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
store_active_from
string
Nullable
city
string
name
string
longitude
number
Nullable
brand_store_tags
array of string
Nullable
order_integration_id
string
Nullable
parent_store_id
integer
Nullable
location_type
string
Type of location of the fulfilling store.
Enum
code
string
Nullable
fulfillment_channel
string
updated_at
string
| date-time
Nullable
Denotes the date and time when any modifications were made to the store.
store_address_json
object (StoreAddress)
Show
phone
string
created_at
string
| date-time
Denotes the date and time when the transition of the store address was created.
contact_person
string
pincode
integer
address_type
string
The type of the address (e.g., home, office).
address1
string
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
version
string
Nullable
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
city
string
longitude
number
address2
string
area
string
Nullable
email
string
Nullable
updated_at
string
| date-time
Denotes the date and time when any modifications were made to the store.
country_code
string
Uniquely identifies the country of the store addressds_type using the two-character standard ISO 3166-1 alpha-2 country codes. Examples include 'US' for the United States and 'IN' for India.
country
string
landmark
string
latitude
number
state
string
meta
object (StoreMeta)
Show
additional_contact_details
object
Nullable
Provides a flexible structure for storing extra contact information related to the store.
timing
array of object
Nullable
notification_emails
array of string
Nullable
gst_number
string
Nullable
ewaybill_portal_details
object
Nullable
Contains essential information and settings related to the e-Way Bill portal, which is used for generating and managing e-waybills for the transportation of goods under specific tax regulations.
einvoice_portal_details
object (EInvoicePortalDetails)
Show
username
string
Nullable
user
string
Nullable
password
string
Nullable
gst_credentials
object (StoreGstCredentials)
Show
e_invoice
object (StoreEinvoice)
Show
username
string
Nullable
user
string
Nullable
password
string
Nullable
enabled
boolean
e_waybill
object (StoreEwaybill)
Show
enabled
boolean
Nullable
stage
string
product_return_config
object
Nullable
Product return configuration details for the location. It can include details like on_same_store denoting whether return can be initiated at the same store.
documents
object (StoreDocuments)
Show
gst
object (Document)
Show
value
string
type
string
Type of the document.
verified
boolean
legal_name
string
url
string
Nullable
display_name
string
s_id
string
Nullable
state
string
country
string
packaging_material_count
integer
Nullable
is_archived
boolean
Nullable
login_username
string
Nullable
mall_name
string
Nullable
latitude
number
Nullable
address2
string
Nullable
fyndstore_emp
object
Nullable
Fynd store employee details.
gst_details
object (GSTDetailsData)
Show
cgst_tax_percentage
number
Nullable
The percentage of Central Goods and Services Tax (CGST) applicable on the goods or services.
gstin_code
string
Nullable
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.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
gst_fee
number
The total GST fee charged on the goods or services.
igst_tax_percentage
number
Nullable
The percentage of Integrated Goods and Services Tax (IGST) applicable for inter-state transactions.
gst_tax_percentage
number
Nullable
The overall GST tax percentage applicable to the goods or services.
hsn_code_id
string
Nullable
Unique identifier for the Harmonized System of Nomenclature (HSN) code used to classify goods.
igst_gst_fee
number
Nullable
The GST fee applicable for IGST, usually for inter-state transactions.
is_default_hsn_code
boolean
Nullable
Indicates whether this HSN code is the default classification for the goods.
sgst_gst_fee
number
Nullable
The GST fee applicable for State Goods and Services Tax (SGST).
tax_collected_at_source
number
Tax amount collected at the source of income or transaction, often for compliance and revenue tracking.
brand_calculated_amount
number
Amount calculated by the brand, potentially reflecting costs, fees, or pricing structures.
cgst_gst_fee
number
Nullable
The GST fee applicable for CGST.
gst_tag
string
Nullable
A tag or label used to denote GST-related attributes or classifications.
sgst_tax_percentage
number
Nullable
The percentage of State Goods and Services Tax (SGST) applicable on the goods or services.
hsn_code
string
Nullable
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.
invoice
object (InvoiceDetails)
Nullable
Show
updated_date
string
| date-time
Nullable
Specifies the date and time when the invoice was last updated.
store_invoice_id
string
Nullable
invoice_url
string
Nullable
label_url
string
Nullable
item
object (Item)
Show
attributes
object
A dictionary of product attributes
brand_id
integer
slug_key
string
webstore_product_url
string
Nullable
l3_category
integer
Nullable
Represents the product's classification at the third level in the e-commerce platform's category hierarchy, using an integer identifier. This finer level of categorization allows for precise product organization and easier navigation for customers seeking specific items.
l3_category_name
string
Nullable
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.
last_updated_at
string
| date-time
Nullable
Denotes the date and time when the item was updated.
name
string
l2_category
array of string
Nullable
The l2_category field represents the second level of categorization for items within an e-commerce platform's hierarchy. This allows for classification beyond the top-tier (level 1) categories, helping customers to narrow down their search and find products
brand
string
image
array of string
code
string
Nullable
l1_category_id
integer
Nullable
The unique identifier of the defines the top-tier categories to which a product belongs within the e-commerce platform's hierarchy.
item_id
integer
l1_category
array of string
Nullable
This array defines the top-tier categories to which a product belongs within the e-commerce platform's hierarchy.
gender
string
Nullable
can_cancel
boolean
Nullable
can_return
boolean
Nullable
size
string
branch_url
string
Nullable
meta
object
Nullable
Meta data of the item contains additional, potentially dynamic information about the item.
color
string
Nullable
department_id
integer
Nullable
l2_category_id
integer
Nullable
journey_type
string
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
line_number
integer
A unique identifying number associated with the bag. It is generated sequentially as bags are created.
lock_status
boolean
Nullable
Indicates whether the bag is locked from further changes (true/false). A locked bag cannot undergo modifications until unlocked.
manifest_id
string
Nullable
The identifier-assigned bags receive after they are manifest (thereby creating a shipment in conjunction with the allocated manifest).
meta
object
Meta data of the bag details contains additional, potentially dynamic information about the bag details.
mode_of_payment
string
Nullable
This field reflects the payment method used in the transaction for a particular bag.
no_of_bags_order
integer
Nullable
The total number of bags in this bag's order.
operational_status
string
Nullable
The particular state a bag occupies in the shipment life-cycle.
order
object (OrderDetails)
Show
fynd_order_id
string
created_at
string
| date-time
Date and time when the order was created.
user_id
string
Nullable
tax_details
object (TaxDetails)
Show
pan_no
string
Nullable
gstin
string
Nullable
mongo_cart_id
number
Nullable
delivery_charges
number
Nullable
transaction_id
string
Nullable
collect_by
string
headers
object
Nullable
Header details of the order.
coupon_value
number
Nullable
order_value
number
created_time
string
currency
string
The currency in which the prices details associated with the item is specified.
total_order_value
number
ordering_channel
string
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
meta
object
Nullable
Meta data of the order data contains additional, potentially dynamic information about the order data.
cod_charges
number
Nullable
cashback_value
number
Nullable
refund_by
string
affiliate_order_date
string
| date-time
Nullable
Specifies the date and time of the order when it was created within the affiliate's system. It specifies that the date and time are recorded in ISO 8601 format.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. The structure is designed to accommodate any number of payment methods,providing flexibility and comprehensive insights into each transaction's payment aspect.
affiliate_order_id
string
payment_mode_id
number
Nullable
promotion_effective_discount
number
Nullable
mode_of_payment
string
discount
number
Nullable
cashback_applied
number
Nullable
fynd_credits
number
Nullable
affiliate_id
string
ordering_channel_logo
string
Nullable
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
loyalty_discount_details
object (LoyaltyDiscountDetails)
Show
Object containing detailed information about the loyalty discount applied during an order.
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed.
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace.
Enum
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order.
order_integration_id
string
Nullable
A unique identifier used for integrating this order with external systems or services.
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
order_value
number
Nullable
An estimated value of the order at the time of placement or sale.
ordering_store
object (Store)
Nullable
Show
phone
string
is_active
boolean
Nullable
company_id
integer
alohomora_user_id
integer
Nullable
created_at
string
| date-time
Denotes the date and time when the store was created.
contact_person
string
store_email
string
is_enabled_for_recon
boolean
Nullable
pincode
string
mall_area
string
Nullable
vat_no
string
Nullable
address1
string
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
store_active_from
string
Nullable
city
string
name
string
longitude
number
Nullable
brand_store_tags
array of string
Nullable
order_integration_id
string
Nullable
parent_store_id
integer
Nullable
location_type
string
Type of location of the fulfilling store.
Enum
code
string
Nullable
fulfillment_channel
string
updated_at
string
| date-time
Nullable
Denotes the date and time when any modifications were made to the store.
store_address_json
object (StoreAddress)
Show
phone
string
created_at
string
| date-time
Denotes the date and time when the transition of the store address was created.
contact_person
string
pincode
integer
address_type
string
The type of the address (e.g., home, office).
address1
string
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
version
string
Nullable
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
city
string
longitude
number
address2
string
area
string
Nullable
email
string
Nullable
updated_at
string
| date-time
Denotes the date and time when any modifications were made to the store.
country_code
string
Uniquely identifies the country of the store addressds_type using the two-character standard ISO 3166-1 alpha-2 country codes. Examples include 'US' for the United States and 'IN' for India.
country
string
landmark
string
latitude
number
state
string
meta
object (StoreMeta)
Show
additional_contact_details
object
Nullable
Provides a flexible structure for storing extra contact information related to the store.
timing
array of object
Nullable
notification_emails
array of string
Nullable
gst_number
string
Nullable
ewaybill_portal_details
object
Nullable
Contains essential information and settings related to the e-Way Bill portal, which is used for generating and managing e-waybills for the transportation of goods under specific tax regulations.
einvoice_portal_details
object (EInvoicePortalDetails)
Show
username
string
Nullable
user
string
Nullable
password
string
Nullable
gst_credentials
object (StoreGstCredentials)
Show
e_invoice
object (StoreEinvoice)
Show
username
string
Nullable
user
string
Nullable
password
string
Nullable
enabled
boolean
e_waybill
object (StoreEwaybill)
Show
enabled
boolean
Nullable
stage
string
product_return_config
object
Nullable
Product return configuration details for the location. It can include details like on_same_store denoting whether return can be initiated at the same store.
documents
object (StoreDocuments)
Show
gst
object (Document)
Show
value
string
type
string
Type of the document.
verified
boolean
legal_name
string
url
string
Nullable
display_name
string
s_id
string
Nullable
state
string
country
string
packaging_material_count
integer
Nullable
is_archived
boolean
Nullable
login_username
string
Nullable
mall_name
string
Nullable
latitude
number
Nullable
address2
string
Nullable
parent_promo_bags
object
Nullable
An object containing details of parent promotional bags.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. The structure is designed to accommodate any number of payment methods,providing flexibility and comprehensive insights into each transaction's payment aspect.
payment_type
string
Nullable
The Specific type of payment.
Enum
payments
object
Nullable
Defines allowed payment details for the item.
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Defines any additional charges for the product.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
qc_required
boolean
Nullable
Indicates whether quality check is required for the product.
quantity
number
Nullable
The quantity of the product.
reasons
array of object
Nullable
Information about why the Bag's item/products are being cancelled or returned or exchanged. This keys within this object represent unique
restore_coupon
boolean
Nullable
Indicates whether voucher/wallet points can be reapplied to the product.
restore_promos
object
Nullable
Provides a flexible structure for storing information about promotion details or offers that are eligible for restoration. This can include details such as promo codes, descriptions of the offers, eligibility criteria, restoration conditions, and any other relevant data that supports the reactivation of previously paused or expired promotions.
rto_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
seller_identifier
string
Nullable
A unique identifier assigned by the seller to represent a specific transaction in their order processing system.
shipment
object (Shipment)
Show
line_items
array of object (LineItem)
An array of objects that represent the items included in the shipment.
Show
charges
array of object (Charge)
An array of Charge objects related to the line item. This array must include three mandatory charge types: amount_paid, price_effective and price_marked. Formula to calculate amount_paid = price_effective + cod_charges + delivery_charges - coupon_discount - promo_discount
Show
amount
object (AmountSchema)
Show
The monetary value of the charge, including value and currency details.
currency
string
The value indicating the currency used for the transactions.
value
number
The final amount of the charge.
type
string
The category or type of the charge.
name
string
The name of the charge that indicates its purpose.
code
string
An optional code associated with the charge for internal tracking.
tax
object (Tax)
Show
name
string
The name of the tax indicating its purpose (e.g., VAT, sales tax).
rate
number
| float
The tax rate as a decimal, applied to the transaction amount.
breakup
array of object
An array of objects detailing the components or breakdown of the tax applied.
amount
object
An object representing the total tax amount calculated for the transaction.
meta
object
An object containing metadata relevant to articles or line items.
custom_message
string
A string for any special instructions or messages related to the line item.
quantity
integer
| int32
Quantity of the articles or line items.
seller_identifier
string
Unique identifier of the articles or line items set by seller.
external_line_id
string
External unique identifier of the articles or line items.
external_shipment_id
string
External shipment identifier or marketplace's unique shipment identifier.
processing_dates
object (ProcessingDates)
Show
dp_pickup_slot
object
An object that provides details about the designated pickup time slot for the order.
dispatch_after_date
string
A string indicating the date after which the order will be dispatched.
dispatch_by_date
string
A string representing the latest date by which the order must be dispatched to meet delivery expectations.
confirm_by_date
string
A string that indicates the deadline for the merchant to confirm the order.
customer_pickup_slot
object
An object that provides details of the pick-up time slot set by the customer.
pack_by_date
string
| date-time
Defines the deadline for having the package fully packed and ready for dispatch or pickup, integral to streamlining the fulfillment process.
meta
object
Nullable
Meta data of the shipment contains additional, potentially dynamic information about the shipment.
priority
integer
| int32
Priority level of the shipment.
location_id
integer
| int32
Location/store/fulfillment identifier of the shipment. This field is mandatory when optimal_shipment_creation flag is set to false, indicating that shipments must be associated with a specific location. When optimal_shipment_creation is true, location_id becomes optional and the system automatically assigns the optimal location for order creation.
order_type
string
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 undergoes all state transitions typical for a delivery, from processing the shipment to final delivery at the customer's address.
"PickAtStore": The order is prepared for pickup and moved to a state where it is ready to be handed over directly to the customer at the store. This type streamlines the process by bypassing traditional shipping stages and facilitating a quicker transition to the final handover stage.
"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
tags
array of object (Tag)
Nullable
Show
Tag provides a way to categorize or label shipment for easier identification, filtering, or tracking.
slug
string
A unique identifier or short label for the tag for shipment reference.
display_text
string
Label of the tag. This text is shown to users, representing the tag in an human-readable format.
system_messages
array of object (SystemMessages)
Show
Shows messages at Fynd Commerce's Order Details
message_type
string
Specifies the type of message.
Enum
priority
number
This will determine the sequence of messages (1 being the highest priority).
message
string
Message to be displayed at Platform's Order Details.
inject_at
array of string
Holds the list of OMS status at which the message should be visible.
process_after_config
object (ProcessAfterConfig)
Show
Configuration to override the default shipment processing behavior, allowing the shipment to be processed after a specified interval.
is_scheduled_shipment
boolean
Indicates whether the shipment is scheduled for later processing.
enable_processing_after
string
| date-time
Specifies the UTC time after which the shipment will be automatically processed.
parent_type
string
Nullable
store_invoice_id
string
Nullable
lock_status
string
Nullable
type
string
Nullable
billing_address_json
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
id
string
fulfilment_priority
integer
Nullable
is_active
boolean
previous_shipment_id
string
Nullable
pdf_links
object
Nullable
PDF Links associated with the shipment.
delivery_address_json
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
eway_bill_id
string
Nullable
affiliate_shipment_id
string
Nullable
fynd_order_id
string
created_at
string
| date-time
Specifies the date and time when the shipment was created.
delivery_awb_number
string
Nullable
hand_over_contact_json
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
credit_note_id
string
Nullable
parent_id
string
Nullable
affiliate_id
string
packaging_type
string
Nullable
Defines the type of packaging used for the product, encompassing materials, design, and form factors.
vertical
string
Nullable
quantity
number
Nullable
status
object (ShipmentStatusData)
Show
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
bag_list
array of string
Nullable
The list of bags that are in this shipment status transition.
id
integer
Nullable
Unique identifier for a shipment status.
created_at
string
| date-time
Nullable
Denotes the date and time when the transition was created.
created_ts
string
Nullable
A timestamp indicating when the status entry was created.
shipment_id
string
Nullable
The unique identifier for the shipment.
status
string
Nullable
The current status of the shipment.
display_name
string
Nullable
A user-friendly name or description of the current shipment status.
current_shipment_status
string
Nullable
Reflects the most recent status of the shipment.
status_created_at
string
| date-time
Nullable
Denotes the date and time when the transition of the status of the shipment was created.
price
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
gst
object (ShipmentGstDetails)
Nullable
Show
value_of_good
number
Nullable
gst_fee
number
Nullable
brand_calculated_amount
number
Nullable
tax_collected_at_source
number
Nullable
gstin_code
string
Nullable
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.
shipment_details
object (ShipmentDetails)
Nullable
Show
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
shipments
integer
| int32
fulfillment_id
integer
| int32
articles
array of object (ArticleDetails)
Show
_id
string
A unique identifier for the article, facilitating easy reference and management within the system.
brand_id
integer
| int32
Numerical code representing the brand associated with the article, linking it to its manufacturer or creator.
dimension
object
Specifies the physical dimensions of the article, including height, width, and depth, providing a comprehensive understanding of its size.
category
object
Classifies the article into a specific category or type, aiding in organization and filtering based on its nature or usecase.
weight
object
Details the weight of the article, crucial for logistics, shipping calculations, and customer information.
attributes
object
Holds additional descriptive details and characteristics of the article, such as color, material, and style, enhancing product understanding.
quantity
integer
| int32
Specifies the available or required quantity of the article, important for inventory management and order fulfillment.
dp_id
string
| int32
Nullable
meta
object
affiliate_shipment_id
string
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment.
lock_status
boolean
Nullable
action_to_status
object
Nullable
This field maps potential actions (e.g., downloading an invoice or label) to their corresponding shipment lock statuses, indicating which operations are allowed depending on the shipment's current lock status. When an action is set to 'lock', it means no transitions or updates to the shipment's status can be performed until the specified action is completed. For instance, if 'download_invoice' is in a 'lock' state, the shipment cannot undergo any status transitions until the invoice is either downloaded. Similarly, 'download_label' being in a 'lock' state prevents any shipment status transitions until a new label is downloaded.
shipment_id
string
Nullable
Unique identifier of the shipment.
shipment_gst
object (ShipmentGstDetails)
Nullable
Show
value_of_good
number
Nullable
gst_fee
number
Nullable
brand_calculated_amount
number
Nullable
tax_collected_at_source
number
Nullable
gstin_code
string
Nullable
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.
shipment_status
object (ShipmentStatusData)
Show
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
bag_list
array of string
Nullable
The list of bags that are in this shipment status transition.
id
integer
Nullable
Unique identifier for a shipment status.
created_at
string
| date-time
Nullable
Denotes the date and time when the transition was created.
created_ts
string
Nullable
A timestamp indicating when the status entry was created.
shipment_id
string
Nullable
The unique identifier for the shipment.
status
string
Nullable
The current status of the shipment.
display_name
string
Nullable
A user-friendly name or description of the current shipment status.
current_shipment_status
string
Nullable
Reflects the most recent status of the shipment.
status_created_at
string
| date-time
Nullable
Denotes the date and time when the transition of the status of the shipment was created.
shipment_status_history
array of object (ShipmentStatusData)
Nullable
Status history of the shipment item in the order.
Show
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
bag_list
array of string
Nullable
The list of bags that are in this shipment status transition.
id
integer
Nullable
Unique identifier for a shipment status.
created_at
string
| date-time
Nullable
Denotes the date and time when the transition was created.
created_ts
string
Nullable
A timestamp indicating when the status entry was created.
shipment_id
string
Nullable
The unique identifier for the shipment.
status
string
Nullable
The current status of the shipment.
display_name
string
Nullable
A user-friendly name or description of the current shipment status.
current_shipment_status
string
Nullable
Reflects the most recent status of the shipment.
status_created_at
string
| date-time
Nullable
Denotes the date and time when the transition of the status of the shipment was created.
status
object (BagReturnableCancelableStatus)
Show
is_returnable
boolean
Indicates whether the bag can be returned by the customer.
is_active
boolean
Specifies if the current status of the bag is active, affecting its eligibility for return or cancellation.
can_be_cancelled
boolean
Indicates if the bag order can be cancelled by the customer.
enable_tracking
boolean
Indicates whether tracking is enabled for the bag, allowing customers to monitor its status.
is_customer_return_allowed
boolean
Specifies if the customer is permitted to return the bag, based on the return policy.
tags
array of string
Nullable
A list of tags or labels associated with the bag, which might be used for filtering, sorting, or categorizing purposes.
total_shipment_bags
integer
Nullable
The total number of shipped bags.
total_shipments_in_order
integer
Nullable
The total number of shipments in the order.
transaction_type
string
Nullable
Specifies the type of the transaction being processed. This classification helps in distinguishing between different operational processes and allows for tailored handling of each transaction type. For example, a 'shipment' transaction type refers to operations related to the shipping of goods.
Enum
type
string
Nullable
The type of the bag.
updated_at
string
| date-time
Nullable
The date and time when the bag was last updated.
user
object (UserDetails)
Nullable
Show
user_oid
string
Nullable
external_customer_id
string
Nullable
first_name
string
Nullable
last_name
string
Nullable
mobile
string
Nullable
email
string
Nullable
is_anonymous_user
boolean
Nullable
gender
string
Nullable
mongo_user_id
string
Nullable
meta
object
Nullable
Meta data of the user details contains additional, potentially dynamic information about the user details.
weight
object (WeightData)
Nullable
Show
value
number
Nullable
unit
string
Nullable
original_bag_list
array of integer
Nullable
Specifies the list of integers that specify the bag number
identifier
string
Nullable
The unique identifier for the bag.
page
object (BagsPage)
Show
item_total
integer
has_next
boolean
page_type
string
The type of the page.
current
integer
size
integer
Examples
Parameters
company_id:
1
bag_ids:
"value"
shipment_ids:
"value"
order_ids:
"value"
channel_bag_ids:
"value"
channel_shipment_ids:
"value"
channel_order_ids:
"value"
channel_id:
"value"
page_no:
1
page_size:
1
Response
List bags
getBags
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.
Operations
GET
# Get channel configuration
POST
# Create channel configuration
POST
# Attach order to a user
POST
# Create Order
GET
# Get order
GET
# List orders
Parameters
company_idpath
integer
Required
GET
Response
200
Successfully created the config data
Hide
config_data
object (CreateChannelConfig)
Show
dp_configuration
object (DPConfiguration)
Show
Configuration settings for Delivery Partner (DP) assignment, determining how the order's shipping is managed.
shipping_by
string
It denotes DP assignment strategy. If it is fynd, DP assignment will be handled by Fynd's OMS.
Enum
shipment_assignment
string
location_reassignment
boolean
logo_url
object
payment_info
object (CreateChannelPaymentInfo)
Show
source
string
payment_methods
array of object (PaymentMethods)
Show
collect_by
string
refund_by
string
mode
string
mode_of_payment
string
lock_states
array of string
Examples
Parameters
company_id:
1
Response
Get channel configuration
getChannelConfig
Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel
Parameters
company_idpath
integer
Required
bodyrequestBody
object (CreateChannelConfigData)
Required
Hide
config_data
object (CreateChannelConfig)
Show
dp_configuration
object (DPConfiguration)
Show
Configuration settings for Delivery Partner (DP) assignment, determining how the order's shipping is managed.
shipping_by
string
It denotes DP assignment strategy. If it is fynd, DP assignment will be handled by Fynd's OMS.
Enum
shipment_assignment
string
location_reassignment
boolean
logo_url
object
payment_info
object (CreateChannelPaymentInfo)
Show
source
string
payment_methods
array of object (PaymentMethods)
Show
collect_by
string
refund_by
string
mode
string
mode_of_payment
string
lock_states
array of string
Request body
config_data
object (CreateChannelConfig)
Show
dp_configuration
object (DPConfiguration)
Show
Configuration settings for Delivery Partner (DP) assignment, determining how the order's shipping is managed.
shipping_by
string
It denotes DP assignment strategy. If it is fynd, DP assignment will be handled by Fynd's OMS.
Enum
shipment_assignment
string
location_reassignment
boolean
logo_url
object
payment_info
object (CreateChannelPaymentInfo)
Show
source
string
payment_methods
array of object (PaymentMethods)
Show
collect_by
string
refund_by
string
mode
string
mode_of_payment
string
lock_states
array of string
POST
Response
200
Successfully updateShipmentStatus!
Hide
is_inserted
boolean
is_upserted
boolean
acknowledged
boolean
Examples
Parameters
company_id:
1
body:
body
Response
Create channel configuration
createChannelConfig
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
bodyrequestBody
object (AttachOrderUser)
Required
Hide
otp_data
object (AttachUserOtpData)
Required
Show
request_id
string
Required
A string representing a unique identifier for the OTP request.
fynd_order_id
string
Required
A unique identifier for the order associated with the user attach.
user_info
object (AttachUserInfo)
Required
Show
first_name
string
Required
A string representing the user's first name.
last_name
string
Required
A string representing the user's last name.
mobile
string
Required
A string representing the user's mobile number.
country_code
string
Uniquely identifies the country associated with the user information. This code is essential for international shipments, ensuring accurate routing and delivery across global postal and customs services. Examples include 'US' for the United States, 'IN' for India.
Request body
otp_data
object (AttachUserOtpData)
Required
Show
request_id
string
Required
A string representing a unique identifier for the OTP request.
fynd_order_id
string
Required
A unique identifier for the order associated with the user attach.
user_info
object (AttachUserInfo)
Required
Show
first_name
string
Required
A string representing the user's first name.
last_name
string
Required
A string representing the user's last name.
mobile
string
Required
A string representing the user's mobile number.
country_code
string
Uniquely identifies the country associated with the user information. This code is essential for international shipments, ensuring accurate routing and delivery across global postal and customs services. Examples include 'US' for the United States, 'IN' for India.
POST
Response
200
Attach user to order
Hide
success
boolean
Indicates whether the API call was successful (true) or not (false).
message
string
A descriptive message providing additional information about the API response.
Examples
Parameters
Parameters are not required.
Response
Attach order to a user
attachOrderUser
Creates an order in the Order Management System (OMS). You can use getOptimalLocations (optional) to identify the most suitable fulfilment location and createShipments (optional) to create shipments before creating the order. See the Create Order use-case document for various order creation scenarios to accommodate different business requirements and customer needs.
Parameters
company_idpath
integer
Required
bodyrequestBody
object (CreateOrderRequestSchema)
Required
Hide
The request schema for creating an order.
shipments
array of object (CreateOrderShipmentSchema)
List of shipments included in the order.
Show
The request schema for creating a shipment.
is_mto
boolean
Indicates if the shipment belongs to the made-to-order category, i.e., the seller will start creating this order after receiving an order creation request.
shipment_lifecycle_messages
array of object (LifecycleMessageSchema)
List of general-purpose messages shown across different points in the shipment's journey at Order Details screen.
Show
General-purpose messages displayed at different points in the order lifecycle.
message
string
Required
The message text to display to users at specific order states (e.g., PLACED, SHIPPED).
Default Value : INFO
type
string
Required
The message type, which determines the color of the message bar.
Enum
states
array of string
Required
List of OMS states at which the message should be visible.
priority
integer
Required
Determines the message display sequence, with '1' being the highest priority.
tags
array of string
Tags that can be attached to the shipment for filtering and categorization.
type
string
The shipment type defining the fulfillment method and processing flow. Each type determines the specific journey a shipment will follow based on operational needs and customer preferences: "HomeDelivery": Standard delivery to the customer's address, undergoing all typical state transitions from processing to final delivery. "PickAtStore": Order prepared for in-store pickup, bypassing traditional shipping stages for direct handover to the customer. "Digital": Orders involving digital goods or services (e.g., software, e-books, subscriptions) delivered electronically.
Enum
fulfillment_option
object (FulfillmentOptionSchema)
Show
name
string
The name of the fulfillment option (e.g., 'Standard Shipping', 'Express Delivery').
Default Value : Standard Delivery
slug
string
A unique identifier for the fulfillment option.
Default Value : standard-delivery
is_default
boolean
The category or method of fulfillment (e.g., 'Pickup', 'Delivery', 'Courier').
Default Value : true
type
string
Indicates whether this fulfillment option is the default choice for customers.
Default Value : HomeDelivery
external_shipment_id
string
Unique identifier for the shipment as assigned by an external system. Use this to map the external ID to Fynd's generated ID.
invoice_id
string
Indicates whether the order was created in offline mode. Used to enable offline-specific processing and sync behavior.
line_items
array of object (LineItemSchema)
A list of items included in the shipment.
Show
seller_identifier
string
Identifier of the seller selling the item.
payment_methods
array of object (LineItemPaymentMethodSchema)
Required
Payment methods used to sell this order.
Show
Payment methods used to fulfill this order.
gateway
object (PaymentMethodGatewaySchema)
Show
Gateway details.
name
string
Required
Payment gateway name e.g., Razorpay, Stripe, etc.
logo
string
mode_of_payment
object (PaymentMethodModeOfPaymentSchema)
Show
Details of the Payment Mode Used.
name
string
Required
Payment mode name e.g., Credit Card, Debit Card, Net Banking, Wallet, etc.
slug
string
Required
Slug of the payment mode e.g., cc, dc, nb, wl, etc.
sub_mode_of_payment
object (SubModeOfPaymentSchema)
Show
Sub mode of payment.
name
string
Required
Name of the sub-mode of payment. For example, if the payment mode is 'Paytm', a sub-mode could be 'Paytm Wallet'.
amount_paid
integer
Total amount paid by this payment method
payment_identifier
string
Transaction id
transaction_party
object (PaymentMethodTransactionPartySchema)
Show
Details about financial responsibilities.
refund_bearer
string
Required
Entity responsible for refunding the amount paid by the customer
Enum
collection_bearer
string
Required
Entity responsible for collection of amount paid by the customer
Enum
monetary_values
object (LineItemMonetaryValuesSchema)
Required
Show
Financial details associated with the line item (note all the values will be in ordering currency i.e customer paid currency).
Price Calculation Rules: The updated price values must comply with the following rules:
Brand Calculated Price:
brand_calculated_price = price_effective - Seller Coupon Discount - Seller Promotion Discount
Value of Goods:
value_of_goods = brand_calculated_price - gst_amount
Amount Paid:
amount_paid = price_effective + cod_charges + delivery_charges + article_charge - coupon_effective_discount - promotion_effective_discount
amount_paid
number
Required
Amount paid by the customer
price_effective
number
Required
The final effective price after applying discounts, promotional offers, and adjustments.
discount
number
Discount amount apart from promo and coupon discount
price_marked
number
Required
The original marked price of the item before any discounts or promotions.
coupon_discount
number
Coupon discount applied for this article
cod_charges
number
Cash on Delivery Charges Applied for this Article.
promo_discount
number
Promotion Discount
gift_price
number
Gift Price
delivery_charges
number
Delivery Charges Applied for this Article.
gift_details
object (GiftDetailsSchema)
Show
Provides information about any gift-related attributes tied to the order line item.
amount
number
Required
Specifies the value or cost of the gift associated with the order line item.
display_text
string
Required
A short description or label intended for display purposes. This can be a message to the customer, such as "Gift wrap included" or "Gift card value applied."
special_instructions
string
These instructions are added by the customer at checkout for the seller's reference.
dimension
object (DimensionSchema)
Show
The Dimensions of the Product, Required For Courier partner processing.
height
integer
Required
Height of the product.
length
integer
Required
Length of the product.
width
integer
Required
Width of the product
is_default
boolean
Required
Not Modified, meaning these are same as product uploaded while loading catelogue.
unit
string
Required
Unit of the measurement used.
quantity
number
Quantity of the Line Item
external_line_id
string
Unique identifier for the LineItem as assigned by an external system. You can use this to map external id to Fynd's generated id
bundle_details
object (BundleDetailsSchema)
Show
is_base
boolean
Required
This serves as the base item, with all other items acting as child elements within the bundle to display the hero product prominently at the top.
images
array of string
Required
An array of image URLs associated with the bundle.
group_id
string
Required
Unique group identifier for the bundle generated by seller to club the articles
name
string
Required
Name of the bundle.
item_type
string
Required
Type of the bundle item
Enum
item_id
integer
Required
Unique identifier of the item.
item_code
string
Required
Item code for the item.
item_name
string
Required
Name of the item.
seller_identifier
string
Required
Identifier for the seller of the bundle.
bundle_article_quantity
integer
In orders with multiple quantities of the same line item, the line item count remains constant, but multiple bundles can exist. To distinguish between these bundles, the article quantity must be used.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
charges
array of object (CreateOrderLineItemChargeSchema)
Custom line-item-level charges attached to this bag and folded into its payment methods. The amount is per unit and is multiplied by quantity.
Show
A custom charge injected at line-item level. The charge is attached to the bag and folded into the bag's payment methods. Line-item charges are always article-level and are never distributed, so `distribution` does not apply here. The amount is per unit; OMS multiplies it by the line item's quantity.
name
string
Required
Name of the charge that indicates its purpose. Must be at most 25 characters.
Maximum Length : 25
amount
number
| value > true
| value >= 0
Required
The per-unit charge value in the ordering currency. Must be a positive amount.
refundable
boolean
Whether the charge is refunded when the bag is cancelled or returned. When set, this is an explicit per-charge override. When omitted, refundability is governed by the application's charges refund configuration (per order state); there is no fixed default.
tax_rule_id
string
Optional tax rule ID applied to this charge. When provided it must resolve to an existing tax rule for the company; an unresolvable ID is rejected at create time. When omitted, no tax is applied to the charge.
meta
object
Contains metadata related to the shipment
order_fulfillment_timeline
object (OrderFulfillmentTimelineSchema)
Show
The order_fulfillment_timeline key represents the complete set of time-based events and deadlines associated with the fulfillment process of an order. This includes critical timestamps for actions like pickup, dispatch, confirmation, and packing, helping to manage and track the order's journey from the merchant to the customer.
dp_pickup_slot
object (DpPickupSlotSchema)
Show
Represents the time slot the delivery partner will pick up the order. It includes a start and end time.
start_time
string
Required
end_time
string
Required
dispatch_after_date
string
A date indicating when the order can be dispatched (e.g., the earliest possible dispatch date).
dispatch_by_date
string
The latest date the order must be dispatched to meet delivery expectations.
confirm_by_date
string
The deadline by which the seller must confirm the order.
customer_pickup_slot
object (CustomerPickupSlotSchema)
Show
Represents the time slot the customer has set for pickup, with start and end time.
start_time
string
Required
end_time
string
Required
pack_by_date
string
The latest time the package should be packed and ready to dispatch.
location_id
integer
Required
The location ID from which this shipment is being fulfilled.
external_location_id
string
The external location ID from which this shipment is being fulfilled.
return_location_id
integer
Overrides the article's default return location.
courier_partner_details
object (CourierPartnerDetailsSchema)
Show
cp_sort_key
string
A sorting key used for categorizing or sorting courier partners, often related to their performance, costs, or some other factor. (example: E-17A-4, E-17A-6, etc.).
cp_options
array of object (CPOptionsSchema)
Other Available CP's
Show
extension_id
string
A string that uniquely identifies the courier partner extension. Refer Get courier partner account to get the extension id.
scheme_id
string
A string that specifies the unique identifier for the scheme associated with the account. Refer Get courier partner account to get the scheme id.
area_code
object (CPAreaCodeSchema)
Show
source
string
Required
destination
string
Required
is_self_ship
boolean
max_reattempts_for_delivery_allowed
integer
cp_sort_key
string
A sorting key used for categorizing or sorting courier partners, often related to their performance, costs, or some other factor, (example: E-17A-4, E-17A-6, etc.).
name
string
The name of the courier partner or the delivery agent handling the shipment.
rider_details
object (CPRiderDetailsSchema)
Show
name
string
Required
phone
string
Required
using_own_creds
boolean
Specifies whether the seller's credentials are being used for the courier partner.
qc_supported
boolean
Specifies that Assigned CP support's quality checks
scheme_id
string
Required
name
string
Required
The name of the courier partner or the delivery agent handling the shipment.
extension_id
string
Required
rider_details
object (CPRiderDetailsSchema)
Show
name
string
Required
phone
string
Required
qc_supported
boolean
Specifies that Assigned CP support's quality checks
using_own_creds
boolean
Specifies weather the Seller's Creds or Fynd's Creds are being used.
max_reattempts_for_delivery_allowed
integer
Reattempts Allowed (required for NDR)
tat_to_deliver_the_shipment
object (CPTatToDeliverTheShipmentSchema)
Show
Time cp will take to deliver the shipment
min
integer
Required
max
integer
Required
is_self_ship
boolean
Is every logistic action handled by seller.
tax_details
object (TaxDetailsSchema)
Show
Use this field to bypass the article's taxation (default) settings (note this will be applied to all the monetary values except delviery and cod charges)
hs_code
string
Required
The HS code of the product
tax_rule_id
string
Required
Tax identifier.
promise_details
object (PromiseDetailsSchema)
Show
Promise Details
min_sla
integer
Required
Min TimeStamp (EPOCH) that will be taken to deliver the product
max_sla
integer
Required
Max TimeStamp (EPOCH) that will be taken to deliver the product.
allow_processing_after
string
| date-time
Defines the UTC time at which the shipment will automatically move to the placed state.
meta
object
Additional metadata related to the shipment.
charges
array of object (CreateOrderChargeSchema)
Custom order-level charges (e.g. delivery or COD fees) that OMS distributes across the order's shipments and apportions onto their payment methods.
Show
A custom charge injected at order level. OMS distributes the charge across the order's shipments according to `distribution`, then apportions it across each shipment's payment methods. Use this for charges such as delivery or COD fees that should be tracked and (optionally) excluded from refunds.
name
string
Required
Name of the charge that indicates its purpose (e.g. "Delivery Charge"). Must be at most 25 characters.
Maximum Length : 25
amount
number
| value > true
| value >= 0
Required
The charge value in the ordering currency. Must be a positive amount.
refundable
boolean
Whether the charge is refunded when the shipment is cancelled or returned. When set, this is an explicit per-charge override. When omitted, refundability is governed by the application's charges refund configuration (per order state); there is no fixed default. Set `false` for charges that must never be refunded (e.g. delivery/COD fees).
distribution
string
How the charge is split across the order's shipments. "apportion": split in proportion to each shipment's value (default). "equally": split equally across shipments.
Default Value : apportion
Enum
tax_rule_id
string
Optional tax rule ID applied to this charge. When provided it must resolve to an existing tax rule for the company; an unresolvable ID is rejected at create time. When omitted, no tax is applied to the charge.
tags
array of string
Tags that can be used to filter and categorize orders and shipments.
currency_details
object (CurrencySchema)
Required
Show
Details of the Currency.
ordering_currency
object (OrderingCurrencySchema)
Required
Show
The currency details used for placing the order.
currency_code
string
Required
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
Required
The symbol representing the currency, such as '₹' for Indian Rupee. This is used for display purposes alongside currency amounts.
conversion_rate
object (ConversionRateSchema)
Required
Show
Exchange rate information for currency conversion between ordering and seller currencies.
rate
number
Required
The exchange rate used to convert monetary values from the ordering currency to the seller's currency.
timestamp_ms
integer
Required
The timestamp (in milliseconds) when the conversion rate was applied.
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.
external_creation_date
string
| date-time
Timestamp indicating when the order was created in an external system.
coupon_details
object (CouponSchema)
Show
Information about the coupon applied to the order.
code
string
Required
The coupon code that was applied.
id
string
Required
Unique identifier of the coupon.
ownership
object (CouponOwnershipSchema)
Required
Show
Information about coupon ownership and issuer.
payable_category
string
Required
Indicates who issued the coupon
Enum
is_return_allowed
boolean
Required
Indicates whether returns are allowed when this coupon is applied.
Default Value : true
is_cancellation_allowed
boolean
Required
Indicates whether cancellations are allowed when this coupon is applied.
Default Value : true
billing_details
object (BillingDetailsSchema)
Required
Show
Billing Details of this Order
first_name
string
First name of the customer
phone_code
string
country phone code ex: +91
country
string
Country of the customer
city
string
City of the customer
pincode
string
Pincode of the customer
last_name
string
Last name of the customer
mobile_number
string
Primary phone number of the customer
email
string
Primary email of the customer
state
string
State of the customer
alternate_mobile_number
string
Alternate mobile number
address
string
Billing address of the customer
middle_name
string
Customer's middle name.
title
string
Customer's title or prefix.
house_no
string
House or apartment number of the customer.
geo_location
object (GeoLocationSchema)
Show
Geographic coordinates (latitude and longitude) of the shipping address
latitude
number
A number representing the geographical latitude of the location.
longitude
number
A number representing the geographical longitude of the location
gender
string
Gender of customer
landmark
string
Landmark or reference point near the customer's location.
address_type
string
Address type in the seller's system.
Enum
state_code
string
State code of the customer's location.
floor_no
string
Floor number of the customer's location.
alternate_email
string
Alternate Email Address
address1
string
First line of the address.
address2
string
Second line of the address.
country_iso_code
string
Specifies the country's unique identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code is crucial for distinguishing countries in international transactions, data processing, and shipping logistics.
user_id
string
The unique identifier assigned to the customer. Refer Customer to get more details.
area_code
string
Area Code
area_code_slug
string
country_phone_code
string
primary_payment_mode
string
Required
The primary payment method used for the entire order transaction.
cp_configuration
object (CPConfigurationSchema)
Show
Configuration of Courier Partner
shipping_by
string
Required
Shipping Handled by FYND or SELLER
Enum
logistics_by
string
Specifies who manages the logistics operations and how updates are handled. This determines the flow of logistics information and responsibility for shipment management.
Enum
ordering_location_id
integer
The location ID where the order is placed. Required when the order is placed from one location but fulfilled by another.
allow_location_reassignment
boolean
Allows location reassignment before order confirmation.
Default Value : true
shipping_details
object (ShippingDetailsSchema)
Required
Show
Shipping Details of this Order
first_name
string
First name of the customer
phone_code
string
country phone code ex: +91
country
string
Country of the customer
city
string
City of the customer
pincode
string
Pincode of the customer
last_name
string
Last name of the customer
mobile_number
string
Primary phone number of the customer
email
string
Primary email of the customer
state
string
State of the customer
alternate_mobile_number
string
Alternate mobile number
address
string
Shipping address of the customer
middle_name
string
Customer's middle name.
title
string
Customer's title or prefix.
house_no
string
House or apartment number of the customer.
geo_location
object (GeoLocationSchema)
Show
Geographic coordinates (latitude and longitude) of the shipping address
latitude
number
A number representing the geographical latitude of the location.
longitude
number
A number representing the geographical longitude of the location
gender
string
Gender of customer
landmark
string
Landmark or reference point near the customer's location.
address_type
string
A string representing the address type in the seller's system.
Enum
state_code
string
State code of the customer's location.
floor_no
string
Floor number of the customer's location.
alternate_email
string
Alternate Email Address
address1
string
First line of the address
address2
string
Second line of the address
country_iso_code
string
Specifies the country's unique identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code is crucial for distinguishing countries in international transactions, data processing, and shipping logistics.
user_id
string
The unique identifier assigned to the customer. Refer Customer in platform documentation to get more details. details.
area_code
string
Area Code
area_code_slug
string
country_phone_code
string
external_order_id
string
A unique identifier assigned to the order by an external system or service.
user_details
object (UserDetailsSchema)
Show
Leave this field empty for anonymous orders. Use the Attach User API to associate a user profile with the order later if needed.
gstin
string
The customer's GSTIN (Goods and Services Tax Identification Number).
pan_no
string
The customer's PAN (Permanent Account Number).
order_lifecycle_messages
array of object (LifecycleMessageSchema)
List of order lifecycle messages to be displayed to the seller at Order Details.
Show
General-purpose messages displayed at different points in the order lifecycle.
message
string
Required
The message text to display to users at specific order states (e.g., PLACED, SHIPPED).
Default Value : INFO
type
string
Required
The message type, which determines the color of the message bar.
Enum
states
array of string
Required
List of OMS states at which the message should be visible.
priority
integer
Required
Determines the message display sequence, with '1' being the highest priority.
channel_application_id
string
Identifies the application from which the order was created. Pass this when it differs from the fulfilling company's application.
b2b_gstin_number
string
The GSTIN (Goods and Services Tax Identification Number) for business-to-business transactions.
channel_company_id
string
The company ID where the order is placed. Required when the order is placed from one company but fulfilled by another.
is_draft
boolean
Indicates whether the order is a draft. Draft orders will be moved to upcoming state instead of placed status.
is_offline_order
boolean
Indicates whether the order is an offline order placed through a physical store or offline channel.
meta
object
Metadata related to the order may include additional, dynamic information that provides further context about the order. This information can also be viewed on the Order or Shipment Details page.
Headers
x-ordering-source
string
Required
To uniquely identify the source through which order has been placed.
x-application-id
string
The Application ID is a unique identifier assigned to a storefront that typically follows a 24-character hexadecimal string. Either `x-application-id` or `x-extension-id` header is mandatory. At least one of them must be provided.
x-extension-id
string
The Extension ID is a unique identifier assigned to an extension that typically follows a 24-character hexadecimal string. Either `x-application-id` or `x-extension-id` header is mandatory. At least one of them must be provided.
Request body
shipments
array of object (CreateOrderShipmentSchema)
List of shipments included in the order.
Show
The request schema for creating a shipment.
is_mto
boolean
Indicates if the shipment belongs to the made-to-order category, i.e., the seller will start creating this order after receiving an order creation request.
shipment_lifecycle_messages
array of object (LifecycleMessageSchema)
List of general-purpose messages shown across different points in the shipment's journey at Order Details screen.
Show
General-purpose messages displayed at different points in the order lifecycle.
message
string
Required
The message text to display to users at specific order states (e.g., PLACED, SHIPPED).
Default Value : INFO
type
string
Required
The message type, which determines the color of the message bar.
Enum
states
array of string
Required
List of OMS states at which the message should be visible.
priority
integer
Required
Determines the message display sequence, with '1' being the highest priority.
tags
array of string
Tags that can be attached to the shipment for filtering and categorization.
type
string
The shipment type defining the fulfillment method and processing flow. Each type determines the specific journey a shipment will follow based on operational needs and customer preferences: "HomeDelivery": Standard delivery to the customer's address, undergoing all typical state transitions from processing to final delivery. "PickAtStore": Order prepared for in-store pickup, bypassing traditional shipping stages for direct handover to the customer. "Digital": Orders involving digital goods or services (e.g., software, e-books, subscriptions) delivered electronically.
Enum
fulfillment_option
object (FulfillmentOptionSchema)
Show
name
string
The name of the fulfillment option (e.g., 'Standard Shipping', 'Express Delivery').
Default Value : Standard Delivery
slug
string
A unique identifier for the fulfillment option.
Default Value : standard-delivery
is_default
boolean
The category or method of fulfillment (e.g., 'Pickup', 'Delivery', 'Courier').
Default Value : true
type
string
Indicates whether this fulfillment option is the default choice for customers.
Default Value : HomeDelivery
external_shipment_id
string
Unique identifier for the shipment as assigned by an external system. Use this to map the external ID to Fynd's generated ID.
invoice_id
string
Indicates whether the order was created in offline mode. Used to enable offline-specific processing and sync behavior.
line_items
array of object (LineItemSchema)
A list of items included in the shipment.
Show
seller_identifier
string
Identifier of the seller selling the item.
payment_methods
array of object (LineItemPaymentMethodSchema)
Required
Payment methods used to sell this order.
Show
Payment methods used to fulfill this order.
gateway
object (PaymentMethodGatewaySchema)
Show
Gateway details.
name
string
Required
Payment gateway name e.g., Razorpay, Stripe, etc.
logo
string
mode_of_payment
object (PaymentMethodModeOfPaymentSchema)
Show
Details of the Payment Mode Used.
name
string
Required
Payment mode name e.g., Credit Card, Debit Card, Net Banking, Wallet, etc.
slug
string
Required
Slug of the payment mode e.g., cc, dc, nb, wl, etc.
sub_mode_of_payment
object (SubModeOfPaymentSchema)
Show
Sub mode of payment.
name
string
Required
Name of the sub-mode of payment. For example, if the payment mode is 'Paytm', a sub-mode could be 'Paytm Wallet'.
amount_paid
integer
Total amount paid by this payment method
payment_identifier
string
Transaction id
transaction_party
object (PaymentMethodTransactionPartySchema)
Show
Details about financial responsibilities.
refund_bearer
string
Required
Entity responsible for refunding the amount paid by the customer
Enum
collection_bearer
string
Required
Entity responsible for collection of amount paid by the customer
Enum
monetary_values
object (LineItemMonetaryValuesSchema)
Required
Show
Financial details associated with the line item (note all the values will be in ordering currency i.e customer paid currency).
Price Calculation Rules: The updated price values must comply with the following rules:
Brand Calculated Price:
brand_calculated_price = price_effective - Seller Coupon Discount - Seller Promotion Discount
Value of Goods:
value_of_goods = brand_calculated_price - gst_amount
Amount Paid:
amount_paid = price_effective + cod_charges + delivery_charges + article_charge - coupon_effective_discount - promotion_effective_discount
amount_paid
number
Required
Amount paid by the customer
price_effective
number
Required
The final effective price after applying discounts, promotional offers, and adjustments.
discount
number
Discount amount apart from promo and coupon discount
price_marked
number
Required
The original marked price of the item before any discounts or promotions.
coupon_discount
number
Coupon discount applied for this article
cod_charges
number
Cash on Delivery Charges Applied for this Article.
promo_discount
number
Promotion Discount
gift_price
number
Gift Price
delivery_charges
number
Delivery Charges Applied for this Article.
gift_details
object (GiftDetailsSchema)
Show
Provides information about any gift-related attributes tied to the order line item.
amount
number
Required
Specifies the value or cost of the gift associated with the order line item.
display_text
string
Required
A short description or label intended for display purposes. This can be a message to the customer, such as "Gift wrap included" or "Gift card value applied."
special_instructions
string
These instructions are added by the customer at checkout for the seller's reference.
dimension
object (DimensionSchema)
Show
The Dimensions of the Product, Required For Courier partner processing.
height
integer
Required
Height of the product.
length
integer
Required
Length of the product.
width
integer
Required
Width of the product
is_default
boolean
Required
Not Modified, meaning these are same as product uploaded while loading catelogue.
unit
string
Required
Unit of the measurement used.
quantity
number
Quantity of the Line Item
external_line_id
string
Unique identifier for the LineItem as assigned by an external system. You can use this to map external id to Fynd's generated id
bundle_details
object (BundleDetailsSchema)
Show
is_base
boolean
Required
This serves as the base item, with all other items acting as child elements within the bundle to display the hero product prominently at the top.
images
array of string
Required
An array of image URLs associated with the bundle.
group_id
string
Required
Unique group identifier for the bundle generated by seller to club the articles
name
string
Required
Name of the bundle.
item_type
string
Required
Type of the bundle item
Enum
item_id
integer
Required
Unique identifier of the item.
item_code
string
Required
Item code for the item.
item_name
string
Required
Name of the item.
seller_identifier
string
Required
Identifier for the seller of the bundle.
bundle_article_quantity
integer
In orders with multiple quantities of the same line item, the line item count remains constant, but multiple bundles can exist. To distinguish between these bundles, the article quantity must be used.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
charges
array of object (CreateOrderLineItemChargeSchema)
Custom line-item-level charges attached to this bag and folded into its payment methods. The amount is per unit and is multiplied by quantity.
Show
A custom charge injected at line-item level. The charge is attached to the bag and folded into the bag's payment methods. Line-item charges are always article-level and are never distributed, so `distribution` does not apply here. The amount is per unit; OMS multiplies it by the line item's quantity.
name
string
Required
Name of the charge that indicates its purpose. Must be at most 25 characters.
Maximum Length : 25
amount
number
| value > true
| value >= 0
Required
The per-unit charge value in the ordering currency. Must be a positive amount.
refundable
boolean
Whether the charge is refunded when the bag is cancelled or returned. When set, this is an explicit per-charge override. When omitted, refundability is governed by the application's charges refund configuration (per order state); there is no fixed default.
tax_rule_id
string
Optional tax rule ID applied to this charge. When provided it must resolve to an existing tax rule for the company; an unresolvable ID is rejected at create time. When omitted, no tax is applied to the charge.
meta
object
Contains metadata related to the shipment
order_fulfillment_timeline
object (OrderFulfillmentTimelineSchema)
Show
The order_fulfillment_timeline key represents the complete set of time-based events and deadlines associated with the fulfillment process of an order. This includes critical timestamps for actions like pickup, dispatch, confirmation, and packing, helping to manage and track the order's journey from the merchant to the customer.
dp_pickup_slot
object (DpPickupSlotSchema)
Show
Represents the time slot the delivery partner will pick up the order. It includes a start and end time.
start_time
string
Required
end_time
string
Required
dispatch_after_date
string
A date indicating when the order can be dispatched (e.g., the earliest possible dispatch date).
dispatch_by_date
string
The latest date the order must be dispatched to meet delivery expectations.
confirm_by_date
string
The deadline by which the seller must confirm the order.
customer_pickup_slot
object (CustomerPickupSlotSchema)
Show
Represents the time slot the customer has set for pickup, with start and end time.
start_time
string
Required
end_time
string
Required
pack_by_date
string
The latest time the package should be packed and ready to dispatch.
location_id
integer
Required
The location ID from which this shipment is being fulfilled.
external_location_id
string
The external location ID from which this shipment is being fulfilled.
return_location_id
integer
Overrides the article's default return location.
courier_partner_details
object (CourierPartnerDetailsSchema)
Show
cp_sort_key
string
A sorting key used for categorizing or sorting courier partners, often related to their performance, costs, or some other factor. (example: E-17A-4, E-17A-6, etc.).
cp_options
array of object (CPOptionsSchema)
Other Available CP's
Show
extension_id
string
A string that uniquely identifies the courier partner extension. Refer Get courier partner account to get the extension id.
scheme_id
string
A string that specifies the unique identifier for the scheme associated with the account. Refer Get courier partner account to get the scheme id.
area_code
object (CPAreaCodeSchema)
Show
source
string
Required
destination
string
Required
is_self_ship
boolean
max_reattempts_for_delivery_allowed
integer
cp_sort_key
string
A sorting key used for categorizing or sorting courier partners, often related to their performance, costs, or some other factor, (example: E-17A-4, E-17A-6, etc.).
name
string
The name of the courier partner or the delivery agent handling the shipment.
rider_details
object (CPRiderDetailsSchema)
Show
name
string
Required
phone
string
Required
using_own_creds
boolean
Specifies whether the seller's credentials are being used for the courier partner.
qc_supported
boolean
Specifies that Assigned CP support's quality checks
scheme_id
string
Required
name
string
Required
The name of the courier partner or the delivery agent handling the shipment.
extension_id
string
Required
rider_details
object (CPRiderDetailsSchema)
Show
name
string
Required
phone
string
Required
qc_supported
boolean
Specifies that Assigned CP support's quality checks
using_own_creds
boolean
Specifies weather the Seller's Creds or Fynd's Creds are being used.
max_reattempts_for_delivery_allowed
integer
Reattempts Allowed (required for NDR)
tat_to_deliver_the_shipment
object (CPTatToDeliverTheShipmentSchema)
Show
Time cp will take to deliver the shipment
min
integer
Required
max
integer
Required
is_self_ship
boolean
Is every logistic action handled by seller.
tax_details
object (TaxDetailsSchema)
Show
Use this field to bypass the article's taxation (default) settings (note this will be applied to all the monetary values except delviery and cod charges)
hs_code
string
Required
The HS code of the product
tax_rule_id
string
Required
Tax identifier.
promise_details
object (PromiseDetailsSchema)
Show
Promise Details
min_sla
integer
Required
Min TimeStamp (EPOCH) that will be taken to deliver the product
max_sla
integer
Required
Max TimeStamp (EPOCH) that will be taken to deliver the product.
allow_processing_after
string
| date-time
Defines the UTC time at which the shipment will automatically move to the placed state.
meta
object
Additional metadata related to the shipment.
charges
array of object (CreateOrderChargeSchema)
Custom order-level charges (e.g. delivery or COD fees) that OMS distributes across the order's shipments and apportions onto their payment methods.
Show
A custom charge injected at order level. OMS distributes the charge across the order's shipments according to `distribution`, then apportions it across each shipment's payment methods. Use this for charges such as delivery or COD fees that should be tracked and (optionally) excluded from refunds.
name
string
Required
Name of the charge that indicates its purpose (e.g. "Delivery Charge"). Must be at most 25 characters.
Maximum Length : 25
amount
number
| value > true
| value >= 0
Required
The charge value in the ordering currency. Must be a positive amount.
refundable
boolean
Whether the charge is refunded when the shipment is cancelled or returned. When set, this is an explicit per-charge override. When omitted, refundability is governed by the application's charges refund configuration (per order state); there is no fixed default. Set `false` for charges that must never be refunded (e.g. delivery/COD fees).
distribution
string
How the charge is split across the order's shipments. "apportion": split in proportion to each shipment's value (default). "equally": split equally across shipments.
Default Value : apportion
Enum
tax_rule_id
string
Optional tax rule ID applied to this charge. When provided it must resolve to an existing tax rule for the company; an unresolvable ID is rejected at create time. When omitted, no tax is applied to the charge.
tags
array of string
Tags that can be used to filter and categorize orders and shipments.
currency_details
object (CurrencySchema)
Required
Show
Details of the Currency.
ordering_currency
object (OrderingCurrencySchema)
Required
Show
The currency details used for placing the order.
currency_code
string
Required
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
Required
The symbol representing the currency, such as '₹' for Indian Rupee. This is used for display purposes alongside currency amounts.
conversion_rate
object (ConversionRateSchema)
Required
Show
Exchange rate information for currency conversion between ordering and seller currencies.
rate
number
Required
The exchange rate used to convert monetary values from the ordering currency to the seller's currency.
timestamp_ms
integer
Required
The timestamp (in milliseconds) when the conversion rate was applied.
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.
external_creation_date
string
| date-time
Timestamp indicating when the order was created in an external system.
coupon_details
object (CouponSchema)
Show
Information about the coupon applied to the order.
code
string
Required
The coupon code that was applied.
id
string
Required
Unique identifier of the coupon.
ownership
object (CouponOwnershipSchema)
Required
Show
Information about coupon ownership and issuer.
payable_category
string
Required
Indicates who issued the coupon
Enum
is_return_allowed
boolean
Required
Indicates whether returns are allowed when this coupon is applied.
Default Value : true
is_cancellation_allowed
boolean
Required
Indicates whether cancellations are allowed when this coupon is applied.
Default Value : true
billing_details
object (BillingDetailsSchema)
Required
Show
Billing Details of this Order
first_name
string
First name of the customer
phone_code
string
country phone code ex: +91
country
string
Country of the customer
city
string
City of the customer
pincode
string
Pincode of the customer
last_name
string
Last name of the customer
mobile_number
string
Primary phone number of the customer
email
string
Primary email of the customer
state
string
State of the customer
alternate_mobile_number
string
Alternate mobile number
address
string
Billing address of the customer
middle_name
string
Customer's middle name.
title
string
Customer's title or prefix.
house_no
string
House or apartment number of the customer.
geo_location
object (GeoLocationSchema)
Show
Geographic coordinates (latitude and longitude) of the shipping address
latitude
number
A number representing the geographical latitude of the location.
longitude
number
A number representing the geographical longitude of the location
gender
string
Gender of customer
landmark
string
Landmark or reference point near the customer's location.
address_type
string
Address type in the seller's system.
Enum
state_code
string
State code of the customer's location.
floor_no
string
Floor number of the customer's location.
alternate_email
string
Alternate Email Address
address1
string
First line of the address.
address2
string
Second line of the address.
country_iso_code
string
Specifies the country's unique identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code is crucial for distinguishing countries in international transactions, data processing, and shipping logistics.
user_id
string
The unique identifier assigned to the customer. Refer Customer to get more details.
area_code
string
Area Code
area_code_slug
string
country_phone_code
string
primary_payment_mode
string
Required
The primary payment method used for the entire order transaction.
cp_configuration
object (CPConfigurationSchema)
Show
Configuration of Courier Partner
shipping_by
string
Required
Shipping Handled by FYND or SELLER
Enum
logistics_by
string
Specifies who manages the logistics operations and how updates are handled. This determines the flow of logistics information and responsibility for shipment management.
Enum
ordering_location_id
integer
The location ID where the order is placed. Required when the order is placed from one location but fulfilled by another.
allow_location_reassignment
boolean
Allows location reassignment before order confirmation.
Default Value : true
shipping_details
object (ShippingDetailsSchema)
Required
Show
Shipping Details of this Order
first_name
string
First name of the customer
phone_code
string
country phone code ex: +91
country
string
Country of the customer
city
string
City of the customer
pincode
string
Pincode of the customer
last_name
string
Last name of the customer
mobile_number
string
Primary phone number of the customer
email
string
Primary email of the customer
state
string
State of the customer
alternate_mobile_number
string
Alternate mobile number
address
string
Shipping address of the customer
middle_name
string
Customer's middle name.
title
string
Customer's title or prefix.
house_no
string
House or apartment number of the customer.
geo_location
object (GeoLocationSchema)
Show
Geographic coordinates (latitude and longitude) of the shipping address
latitude
number
A number representing the geographical latitude of the location.
longitude
number
A number representing the geographical longitude of the location
gender
string
Gender of customer
landmark
string
Landmark or reference point near the customer's location.
address_type
string
A string representing the address type in the seller's system.
Enum
state_code
string
State code of the customer's location.
floor_no
string
Floor number of the customer's location.
alternate_email
string
Alternate Email Address
address1
string
First line of the address
address2
string
Second line of the address
country_iso_code
string
Specifies the country's unique identifier allowing the ISO 3166-1 alpha-2 standard. This two-letter code is crucial for distinguishing countries in international transactions, data processing, and shipping logistics.
user_id
string
The unique identifier assigned to the customer. Refer Customer in platform documentation to get more details. details.
area_code
string
Area Code
area_code_slug
string
country_phone_code
string
external_order_id
string
A unique identifier assigned to the order by an external system or service.
user_details
object (UserDetailsSchema)
Show
Leave this field empty for anonymous orders. Use the Attach User API to associate a user profile with the order later if needed.
gstin
string
The customer's GSTIN (Goods and Services Tax Identification Number).
pan_no
string
The customer's PAN (Permanent Account Number).
order_lifecycle_messages
array of object (LifecycleMessageSchema)
List of order lifecycle messages to be displayed to the seller at Order Details.
Show
General-purpose messages displayed at different points in the order lifecycle.
message
string
Required
The message text to display to users at specific order states (e.g., PLACED, SHIPPED).
Default Value : INFO
type
string
Required
The message type, which determines the color of the message bar.
Enum
states
array of string
Required
List of OMS states at which the message should be visible.
priority
integer
Required
Determines the message display sequence, with '1' being the highest priority.
channel_application_id
string
Identifies the application from which the order was created. Pass this when it differs from the fulfilling company's application.
b2b_gstin_number
string
The GSTIN (Goods and Services Tax Identification Number) for business-to-business transactions.
channel_company_id
string
The company ID where the order is placed. Required when the order is placed from one company but fulfilled by another.
is_draft
boolean
Indicates whether the order is a draft. Draft orders will be moved to upcoming state instead of placed status.
is_offline_order
boolean
Indicates whether the order is an offline order placed through a physical store or offline channel.
meta
object
Metadata related to the order may include additional, dynamic information that provides further context about the order. This information can also be viewed on the Order or Shipment Details page.
POST
Response
200
Hide
fynd_order_id
string
Response
Create Order
createOrder
Parameters
company_idpath
integer
Required
Id of company
order_idquery
string
Required
Default Value : FY6299E19701B4EAEFC2
my_ordersquery
boolean
allow_inactivequery
boolean
Flag to allow inactive shipments
Default Value : false
GET
Response
200
We are processing the report!
Hide
order
object (OrderData)
Show
ordering_channel
string
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
ordering_source_details
object (OrderingSourceDetails)
Show
type
string
Type of the ordering source.
Enum
slug
string
Slug identifier of the ordering source.
display_name
string
Display name of the ordering source.
is_active
boolean
Indicates whether the ordering source is active.
logo
string
| uri
Logo URL of the ordering source.
order_date
string
| date-time
Specifies the exact date and time when the order was placed by the customer, serving as a key timestamp for the initiation of the order processing cycle.
created_ts
string
tax_details
object (TaxDetails)
Show
pan_no
string
Nullable
gstin
string
Nullable
meta
object
Meta data of the order contains additional, potentially dynamic information about the order.
fynd_order_id
string
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. This includes metadata such as logos, payment IDs, and merchant codes, as well as transaction-specific details like the payment mode, name, amount, and entities responsible for refunds and collections. The structure is designed to accommodate any number of payment methods, providing flexibility and comprehensive insights into each transaction's payment aspect.
payment_info
array of object (PaymentInfoData)
Nullable
Show
meta
object
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
mode
string
Information about the payment source. For eg, NB_ICICI.
name
string
The name of the payment method (e.g., "Credit Card", "PayPal").
amount
number
Amount paid using this payment method.
collected
boolean
Indicates whether this payment method has been collected or not.
refund_by
string
Payment refund by for the customer and seller (e.g fynd, seller).
collect_by
string
Payment collected by for the customer and seller (e.g fynd, seller).
display_name
string
The name of the payment method as it should be displayed to the user.
merchant_transaction_id
string
A unique identifier associated with the payment transaction, such as TR669796C0012CF31BBD. This ID helps track and reference the specific transaction within the merchant's system.
affiliate_order_id
string
External Order id
affiliate_id
string
Unique identifier for the sales channel.
source
string
Specifies the origin from from which the order is created, including mobile applications, web interfaces, social media integrations, or external APIs.
currency
object (CurrencySchema)
Show
Details of the Currency.
ordering_currency
object (OrderingCurrencySchema)
Show
The currency details used for placing the order.
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.
conversion_rate
object (ConversionRateSchema)
Show
Exchange rate information for currency conversion between ordering and seller currencies.
rate
number
The exchange rate used to convert monetary values from the ordering currency to the seller's currency.
timestamp_ms
integer
The timestamp (in milliseconds) when the conversion rate was applied.
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.
loyalty_discount_details
object (LoyaltyDiscountDetails)
Show
Object containing detailed information about the loyalty discount applied during an order.
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed.
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace.
Enum
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order.
success
boolean
shipments
array of object (PlatformShipment)
Show
fulfillment_option
object (FulfillmentOption)
Show
name
string
slug
string
type
string
is_default
boolean
picked_date
string
| date-time
Nullable
Indicates the date and time when the shipment was physically picked up from the sender or the origin point by the delivery service. This timestamp is crucial for tracking the commencement of the shipment's journey.
tracking_list
array of object (TrackingList)
A list of tracking updates associated with the shipment.
Show
is_passed
boolean
Nullable
A flag indicating whether the tracking event has already occurred. If true, it means the event is in the past; otherwise, it is either current or future.
text
string
A descriptive message or status update associated with the tracking event, providing context about the shipment's progress or condition.
is_current
boolean
Nullable
A flag indicating whether this tracking event is the most recent update. If true, it reflects the latest status of the shipment.
time
string
Nullable
A timestamp representing when the tracking event occurred. This helps in understanding the timeline of the shipment's journey.
created_ts
string
Nullable
A timestamp indicating when the tracking information was created or logged in the system. This may differ from the event time.
status
string
The specific status associated with the tracking event, such as "In Transit," "Delivered," or "Out for Delivery," providing clarity on the shipment's current phase.
invoice
object (InvoiceInfo)
Show
store_invoice_id
string
Nullable
A unique identifier for the invoice generated by the store or platform, used for internal tracking and reference.
invoice_url
string
Nullable
A URL linking to the digital version of the invoice, allowing users to view or download the invoice document online.
updated_date
string
| date-time
Nullable
Denotes the date and time when the invoice information was modified or updated, providing a record of the most recent changes.
external_invoice_id
string
Nullable
An identifier for the invoice used by external systems or partners, facilitating cross-system tracking and reconciliation.
label_url
string
Nullable
A URL linking to the shipping label associated with the invoice, which may be used for shipment tracking and logistics.
credit_note_id
string
Nullable
The identifier for any credit note related to the invoice, used in cases of refunds or adjustments to the original billing.
links
object
An object containing additional links relevant to the invoice, which may include related documents or resources.
shipment_status
string
Nullable
Represents the current status of the shipment.
gst_details
object (GSTDetailsData)
Show
cgst_tax_percentage
number
Nullable
The percentage of Central Goods and Services Tax (CGST) applicable on the goods or services.
gstin_code
string
Nullable
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.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
gst_fee
number
The total GST fee charged on the goods or services.
igst_tax_percentage
number
Nullable
The percentage of Integrated Goods and Services Tax (IGST) applicable for inter-state transactions.
gst_tax_percentage
number
Nullable
The overall GST tax percentage applicable to the goods or services.
hsn_code_id
string
Nullable
Unique identifier for the Harmonized System of Nomenclature (HSN) code used to classify goods.
igst_gst_fee
number
Nullable
The GST fee applicable for IGST, usually for inter-state transactions.
is_default_hsn_code
boolean
Nullable
Indicates whether this HSN code is the default classification for the goods.
sgst_gst_fee
number
Nullable
The GST fee applicable for State Goods and Services Tax (SGST).
tax_collected_at_source
number
Tax amount collected at the source of income or transaction, often for compliance and revenue tracking.
brand_calculated_amount
number
Amount calculated by the brand, potentially reflecting costs, fees, or pricing structures.
cgst_gst_fee
number
Nullable
The GST fee applicable for CGST.
gst_tag
string
Nullable
A tag or label used to denote GST-related attributes or classifications.
sgst_tax_percentage
number
Nullable
The percentage of State Goods and Services Tax (SGST) applicable on the goods or services.
hsn_code
string
Nullable
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.
order_status
object (OrderStatusData)
Show
Object that contains delivery status information, including a descriptive label, time information, color code for visual representation, and the expected delivery date.
order_details
object (OrderDetails)
Show
fynd_order_id
string
created_at
string
| date-time
Date and time when the order was created.
user_id
string
Nullable
tax_details
object (TaxDetails)
Show
pan_no
string
Nullable
gstin
string
Nullable
mongo_cart_id
number
Nullable
delivery_charges
number
Nullable
transaction_id
string
Nullable
collect_by
string
headers
object
Nullable
Header details of the order.
coupon_value
number
Nullable
order_value
number
created_time
string
currency
string
The currency in which the prices details associated with the item is specified.
total_order_value
number
ordering_channel
string
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
meta
object
Nullable
Meta data of the order data contains additional, potentially dynamic information about the order data.
cod_charges
number
Nullable
cashback_value
number
Nullable
refund_by
string
affiliate_order_date
string
| date-time
Nullable
Specifies the date and time of the order when it was created within the affiliate's system. It specifies that the date and time are recorded in ISO 8601 format.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. The structure is designed to accommodate any number of payment methods,providing flexibility and comprehensive insights into each transaction's payment aspect.
affiliate_order_id
string
payment_mode_id
number
Nullable
promotion_effective_discount
number
Nullable
mode_of_payment
string
discount
number
Nullable
cashback_applied
number
Nullable
fynd_credits
number
Nullable
affiliate_id
string
ordering_channel_logo
string
Nullable
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
loyalty_discount_details
object (LoyaltyDiscountDetails)
Show
Object containing detailed information about the loyalty discount applied during an order.
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed.
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace.
Enum
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order.
errors
array of string
A list of any errors that occurred while attempting to obtain the order's status.
shipment_details
array of object (ShipmentDetail)
A list of the individual shipments associated with the order and their current statuses.
Show
shipment_id
string
Unique identifier for the shipment associated with the order.
status
string
A string representing the current status of the shipment
id
integer
| int32
An integer that serves as a unique identifier for the shipment detail
bag_list
array of integer
A list of bag identifiers associated with the shipment.
meta
object (Meta)
Show
kafka_emission_status
integer
| int32
An integer representing the status of the message upon emission to Kafka. 0 indicates success, while 1 indicates failure.
state_manager_used
string
A string that specifies the state manager utilized for handling the order's state.
remarks
string
A string for any additional comments or notes related to the shipment,
text
string
A label or description of the delivery status, such as 'Expected Delivery Date'.
value
string
The detailed delivery status or time information, such as 'Arriving on 24 Nov 2022 15:54:00'.
color_code
string
Hex code for the color representing the delivery status.
expected_delivery_date
string
| date-time
The ISO 8601 formatted date and time when the delivery is expected, e.g., '2022-11-24T22:15:54+00:00'.
delivery_slot
object
Nullable
Represents a specific time window allocated for the delivery of an order or shipment.
order
object (OrderDetailsData)
Show
order_date
string
| date-time
Nullable
Represents the date and time when the order was placed by the customer. This timestamp is essential for tracking the initiation of the order process, scheduling deliveries, and analyzing order timelines.
created_ts
string
Nullable
A timestamp indicating when the order was created in the system.
tax_details
object
Nullable
Contains a flexible and comprehensive set of key-value pairs detailing the tax calculations and classifications applicable to the order.
cod_charges
string
Nullable
The charges associated with Cash on Delivery (COD) payments.
source
string
Nullable
The source from which the order originated.
fynd_order_id
string
An unique identifier for the order.
affiliate_id
string
Nullable
Affiliate id associated with order.
affiliate_order_id
string
Nullable
Affiliate order id associated with order.
ordering_channel_logo
object
Nullable
Represents the logo of the channel through which the order was placed, encapsulating branding elements and any relevant styling attributes. This object is designed to be flexible, allowing for the inclusion of various properties that define how the logo should be displayed across different platforms or documents related to the order.
order_value
string
Nullable
The total monetary value of the order
ordering_channel
string
Nullable
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
loyalty_discount_details
object (LoyaltyDiscountDetails)
Show
Object containing detailed information about the loyalty discount applied during an order.
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed.
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace.
Enum
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order.
meta
object
Meta data of the order contains additional, potentially dynamic information about the order.
user
object (UserDataInfo)
Show
Contains the details of the user who created the order including identifying information and relevant metadata.
id
integer
Nullable
The unique identifier associated with the user.
user_oid
string
Nullable
The object ID for the user, used for referencing the user in various operations.
mongo_user_id
string
Nullable
The identifier for the user.
external_customer_id
string
Nullable
The identifier for the user in external systems.
first_name
string
Nullable
The first name of the user.
last_name
string
Nullable
The last name of the user.
mobile
string
Nullable
The mobile phone number of the user.
email
string
Nullable
The email address of the user.
meta
object
Nullable
Additional metadata related to the user.
is_anonymous_user
boolean
Nullable
Indicates whether the user is an anonymous user (true) or registered (false).
name
string
Nullable
A full name of the user, which may be a combination of first and last name.
gender
string
Nullable
The gender of the user.
country_phone_code
string
The country-specific phone code, useful for formatting mobile numbers correctly.
enable_dp_tracking
boolean
Nullable
A flag indicating whether the delivery partner tracking feature is enabled for this shipment.
custom_message
string
Nullable
A custom message or note associated with the shipment.
estimated_sla_time
string
Nullable
The estimated service level agreement (SLA) time for the shipment, indicating expected delivery timelines.
estimated_sla_ts
string
Nullable
A timestamp indicating when the estimated SLA time is expected to be met.
can_update_dimension
boolean
Nullable
Indicates whether the dimensions of the shipment can be updated after creation.
shipment_images
array of string
Nullable
A list of URLs for images related to the shipment.
delivery_details
object
A list of details about the delivery of an order.
billing_details
object
Information regarding the billing for the shipment, including billing address and payment method.
forward_shipment_id
string
Nullable
The ID of the parent forward journey shipment.
fulfilment_priority
integer
Nullable
The fulfilment priority, with lower numbers indicating a higher priority.
shipment_details
object (ShipmentLockDetails)
Show
lock_status
boolean
Nullable
Represents the lock status of the shipment.
lock_message
string
Nullable
A user-friendly message that explains the reason for locking the shipment.
action_to_status
object
Nullable
This field maps potential actions (e.g., downloading an invoice or label) to their corresponding shipment lock statuses, indicating which operations are allowed depending on the shipment's current lock status. When an action is set to 'lock', it means no transitions or updates to the shipment's status can be performed until the specified action is completed. For instance, if 'download_invoice' is in a 'lock' state, the shipment cannot undergo any status transitions until the invoice is either downloaded. Similarly, 'download_label' being in a 'lock' state prevents any shipment status transitions until a new label is downloaded.
custom_meta
array of object
Nullable
An array of custom metadata objects that may contain additional, dynamic information specific to the shipment.
shipment_quantity
integer
Nullable
The total quantity of items included in the shipment.
company_details
object (CompanyDetails)
Show
company_name
string
Nullable
The name of the company.
address
object
Nullable
It contains the properties for the address of a company.
company_cin
string
Nullable
The Corporate Identification Number (CIN) of the company.
company_id
integer
Nullable
A unique identifier for the company on the platform.
company_gst
string
Nullable
The Goods and Services Tax (GST) number of the company.
company_contact
object (ContactDetails)
Show
phone
array of object (PhoneDetails)
Nullable
An array of phone numbers associated with the contact.
Show
country_code
integer
Nullable
Identifies the country of the user's phone number using the two-character standard ISO 3166-1 alpha-2 country codes. Examples include 'US' for the United States and 'IN' for India.
number
string
Nullable
The actual phone number of the user.
emails
array of string
Nullable
An array of email addresses associated with the contact.
ordering_store
object (OrderingStoreDetails)
Show
phone
string
Nullable
The contact phone number for the ordering store.
pincode
string
Nullable
The postal code associated with the ordering store's location.
meta
object
Nullable
Meta data of the ordering store contains additional, potentially dynamic information about the ordering store.
address
string
Nullable
The complete address of the ordering store.
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
Formatted address based on the title-template provided by the partner.
id
integer
Nullable
A unique identifier for the ordering store.
code
string
Nullable
A specific code associated with the ordering store.
store_name
string
Nullable
The name of the ordering store.
country
string
Nullable
The country in which the ordering store is located.
contact_person
string
Nullable
The name of the primary contact person at the ordering store.
state
string
Nullable
The state or region where the ordering store is situated.
city
string
Nullable
The city in which the ordering store is located.
name
string
Nullable
The name of the ordering store.
store_email
string
Nullable
The email address of the ordering store.
order_platform
string
The platform used to place the order.
lock_status
boolean
Nullable
Indicates whether the shipment is currently locked or not for modifications or updates.
platform_logo
string
Nullable
The URL of the ordering platform's logo.
user_agent
string
Nullable
Information about the user agent string, typically containing details about the browser or application used to place the order.
dp_details
object (DPDetailsData)
Show
pincode
string
Nullable
The postal code associated with the delivery partner's location
track_url
string
Nullable
A URL that provides access to real-time tracking information for the shipment.
eway_bill_id
string
Nullable
The unique identifier for the e-way bill generated for the shipment.
id
integer
Nullable
A unique identifier for the delivery partner details.
country
string
Nullable
The country in which the delivery partner operates.
awb_no
string
Nullable
The Air Waybill number, a tracking number used for air freight shipments, allowing for the identification and tracking of the package in transit.
gst_tag
string
Nullable
A tag associated with the Goods and Services Tax (GST) for the shipment.
name
string
Nullable
The name of the delivery partner or service provider responsible for transporting the shipment.
invoice_id
string
Nullable
The unique identifier for the invoice associated with the shipment.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. The structure is designed to accommodate any number of payment methods,providing flexibility and comprehensive insights into each transaction's payment aspect.
payment_info
array of object
Nullable
An array of objects containing detailed information about the payments made for the shipment.
coupon
object
Nullable
Coupon data of the shipment which denotes if coupon is applied, coupon code, coupon amount, coupon title and coupon message.
affiliate_details
object (AffiliateDetails)
Show
Details of an affiliate associated with a shipment.
shipment_meta
object (ShipmentMeta)
Show
tracking_url
string
Nullable
A URL for tracking the shipment.
estimated_delivery_date
string
| date-time
Nullable
Provides a forecasted date and time by which the shipment is expected to be delivered to the recipient. This estimation is crucial for planning purposes, both for the sender in managing expectations and for the recipient in preparing for receipt.
same_store_available
boolean
Indicates whether the shipment is available for pickup from the same store.
b2b_buyer_details
object (BuyerDetails)
Show
ajio_site_id
string
Nullable
The unique identifier for the buyer on the Ajio platform.
pincode
integer
The postal code for the buyer's shipping address, used for delivery location identification.
address
string
Provides the comprehensive address details of the buyer's shipping address.
gstin
string
The Goods and Services Tax Identification Number (GSTIN) of the buyer.
name
string
The full name of the buyer, essential for personalizing communication and delivery.
state
string
The name of the state where the buyer's shipping address is located, important for logistical purposes.
city
string
The name of the city where the buyer's shipping address is located, which helps in identifying delivery zones.
formatted
object (Formatted)
Show
max
string
Nullable
Represents the maximum formatted value, providing a limit for the associated data, such as dimensions or weights.
min
string
Nullable
Represents the minimum formatted value, establishing a lower limit for the associated data, ensuring it meets certain criteria or standards.
debug_info
object (DebugInfo)
Show
stormbreaker_uuid
string
Nullable
A unique identifier (UUID) associated with the Stormbreaker system, used for tracking and debugging purposes in the application.
return_awb_number
string
Nullable
The Air Waybill (AWB) number associated with a return shipment.
is_self_ship
boolean
Nullable
Indicates whether the shipment is a self-shipped order.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
einvoice_info
object (EinvoiceInfo)
Show
credit_note
object
Nullable
Specifies the reverse einvoice transaction create on government portal.
invoice
object
Nullable
It specifies the forward einvoice transaction created on government portal.
return_affiliate_shipment_id
string
Nullable
The shipment ID associated with a return from an affiliate.
parent_dp_id
string
Nullable
The unique identifier for the parent delivery partner.
shipment_weight
number
Nullable
The total weight of the shipment.
dimension
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment.
assign_dp_from_sb
boolean
Nullable
Indicates whether to assign the delivery partner from the store’s basket.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
store_invoice_updated_date
string
| date-time
Nullable
Denotes the date and time when the store's invoice related to this shipment was updated. This timestamp is vital for tracking changes to billing details, adjustments in charges, or updates in the invoicing status.
forward_affiliate_shipment_id
string
Nullable
The shipment ID for the forward journey of an affiliate shipment.
return_store_node
integer
Nullable
The identifier for the store node involved in the return process.
fulfilment_priority_text
string
Nullable
Textual representation of the fulfillment priority for the shipment.
shipment_tags
array of object (ShipmentTags)
Tags associated with the shipment for categorization and filtering.
Show
slug
string
Nullable
A URL-friendly string representing the tag, often used for routing or categorization.
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
display_text
string
Nullable
A human-readable text representation of the tag, used for display purposes in user interfaces.
external
object
Nullable
External metadata related to the shipment.
awb_number
string
Nullable
The Air Waybill number associated with the shipment.
lock_data
object (LockData)
Show
locked
boolean
Nullable
Indicates whether the shipment is currently locked for processing (true) or not (false).
mto
boolean
Nullable
A flag indicating whether the shipment is part of a multi-modal transport operation.
lock_message
string
Nullable
An optional message providing additional context or information regarding the lock status.
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.
Enum
ewaybill_info
object
Nullable
Electronic Way Bill details i.e ewayBillNo, ewayBillDate that are utilized in the transportation of goods.
dp_id
string
Nullable
The unique identifier for the delivery partner associated with the shipment.
shipment_volumetric_weight
number
Nullable
The volumetric weight of the shipment, which may differ from its actual weight.
marketplace_store_id
string
Nullable
The unique identifier for the marketplace store associated with the shipment.
return_details
object
Nullable
An object containing the return details of the shipment.
dp_sort_key
string
Nullable
A sort key for the delivery partner, used for prioritization.
packaging_name
string
Nullable
The name of the packaging used for the shipment.
timestamp
object (ShipmentTimeStamp)
Show
max
integer
Nullable
Represents the maximum timestamp value, indicating the latest time relevant to the shipment.
min
integer
Nullable
Represents the minimum timestamp value, indicating the earliest time relevant to the shipment.
auto_trigger_dp_assignment_acf
boolean
Nullable
Indicates whether automatic delivery partner assignment is triggered for this shipment.
dp_name
string
Nullable
The name of the delivery partner associated with the shipment.
po_number
string
Nullable
The purchase order number associated with the shipment.
weight
integer
The weight of the shipment, typically measured in grams or kilograms.
b2c_buyer_details
object
Nullable
Contains detailed information about the buyer in a business-to-consumer (B2C) transaction. This object is designed to capture a wide array of buyer-specific data such as contact information, shipping address, preferences, and any other relevant details that enhance the understanding of the buyer's profile and needs.
forward_affiliate_order_id
string
Nullable
The order ID for the forward journey of an affiliate shipment.
return_affiliate_order_id
string
Nullable
The order ID for the return journey of an affiliate shipment.
bag_weight
object
Nullable
This object is designed to accommodate a range of weight-related information. Denotes the weight of the bag, potentially including various measurements or related details.
refund_to
string
Nullable
Specifies the recipient of any refunds related to the shipment.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_shipment_id
string
The shipment ID specific to this affiliate.
company_affiliate_tag
string
Nullable
An optional tag representing the company's affiliate association.
affiliate_order_id
string
The order ID associated with the affiliate shipment.
pdf_links
object (PDFLinks)
Show
invoice_type
string
The type of invoice issued, such as 'fynd' or other classifications.
Enum
label_a6
string
Nullable
URL or path to the A6 size label document.
invoice
string
Nullable
URL or path to the main invoice document.
label_pos
string
Nullable
URL or path to the POS label document.
invoice_a6
string
Nullable
URL or path to the A6 size invoice document.
b2b
string
Nullable
URL or path to the B2B document related to the transaction.
label
string
Nullable
URL or path to the general label document.
label_a4
string
Nullable
URL or path to the A4 size label document.
label_type
string
Specifies the type of label associated with a PDF document,indicating its purpose or content. The label_type helps in organizing and identifying PDF documents quickly, ensuring that users or systems can efficiently utilize the correct documents for required actions.
Enum
invoice_export
string
Nullable
URL or path to the exported invoice document.
credit_note_url
string
Nullable
URL or path to the credit note document.
delivery_challan_a4
string
Nullable
URL or path to the A4 delivery challan document.
label_export
string
Nullable
URL or path to the exported label document.
invoice_a4
string
Nullable
URL or path to the A4 size invoice document.
invoice_pos
string
Nullable
URL or path to the POS invoice document.
po_invoice
string
Nullable
URL or path to the purchase order invoice document.
config
object (AffiliateConfig)
Show
app
object (AffiliateAppConfig)
Show
id
string
description
string
updated_at
string
| date-time
The date and time when the app config was updated.
name
string
token
string
meta
array of object (AffiliateAppConfigMeta)
Show
value
string
name
string
owner
string
secret
string
created_at
string
| date-time
Timestamp when the app config was created.
inventory
object (AffiliateInventoryConfig)
Show
article_assignment
object (AffiliateInventoryArticleAssignmentConfig)
Show
post_order_reassignment
boolean
payment
object (AffiliateInventoryPaymentConfig)
Show
source
string
mode_of_payment
string
inventory
object (AffiliateInventoryStoreConfig)
Show
store
object
Fulfilling store information related to the shipment.
order
object (AffiliateInventoryOrderConfig)
Show
force_reassignment
boolean
logistics
object (AffiliateInventoryLogisticsConfig)
Show
dp_assignment
boolean
app_company_id
integer
Nullable
A unique identifier for the company associated with the affiliate app, used for tracking and managing affiliate relationships.
affiliate_id
string
Nullable
The unique identifier for the affiliate.
affiliate_store_id
string
The unique identifier for the affiliate's store.
affiliate_bag_id
string
The unique identifier for the affiliate's bag.
id
string
Nullable
The unique identifier for the affiliate.
priority_text
string
Nullable
Text that indicates the priority level of the shipment.
bag_status_history
array of object (BagStatusHistory)
A history of status changes for bags associated with the shipment.
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
is_dp_assign_enabled
boolean
Nullable
A flag indicating whether delivery partner assignment features are enabled for the shipment.
bags
array of object (OrderBags)
A list of bags included in the shipment
Show
gst_details
object (GSTDetailsData)
Show
cgst_tax_percentage
number
Nullable
The percentage of Central Goods and Services Tax (CGST) applicable on the goods or services.
gstin_code
string
Nullable
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.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
gst_fee
number
The total GST fee charged on the goods or services.
igst_tax_percentage
number
Nullable
The percentage of Integrated Goods and Services Tax (IGST) applicable for inter-state transactions.
gst_tax_percentage
number
Nullable
The overall GST tax percentage applicable to the goods or services.
hsn_code_id
string
Nullable
Unique identifier for the Harmonized System of Nomenclature (HSN) code used to classify goods.
igst_gst_fee
number
Nullable
The GST fee applicable for IGST, usually for inter-state transactions.
is_default_hsn_code
boolean
Nullable
Indicates whether this HSN code is the default classification for the goods.
sgst_gst_fee
number
Nullable
The GST fee applicable for State Goods and Services Tax (SGST).
tax_collected_at_source
number
Tax amount collected at the source of income or transaction, often for compliance and revenue tracking.
brand_calculated_amount
number
Amount calculated by the brand, potentially reflecting costs, fees, or pricing structures.
cgst_gst_fee
number
Nullable
The GST fee applicable for CGST.
gst_tag
string
Nullable
A tag or label used to denote GST-related attributes or classifications.
sgst_tax_percentage
number
Nullable
The percentage of State Goods and Services Tax (SGST) applicable on the goods or services.
hsn_code
string
Nullable
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.
bag_status
array of object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
parent_promo_bags
object
Nullable
An object containing details of parent promotional bags.
seller_qc_details
object (SellerQcDetails)
Nullable
Show
Provides the seller's quality control details for a bag while accepting return items, including the line number reference and the quantities of items that passed or failed QC.
line_number
integer
Represents the line number in an order or transaction associated with the bag.
bad_quantity
integer
Represents the total number of items in a bag that have failed quality control and are marked as bad QC.
good_quantity
integer
Represents the total number of items in a bag that have passed quality control and are marked as good QC.
financial_breakup
object (FinancialBreakup)
Show
refund_credit
number
The amount of refund credits applicable for the transaction.
amount_paid_roundoff
integer
Nullable
Total amount paid, rounded off to the nearest integer for billing purposes.
price_effective
number
The effective price after applying discounts and before any taxes.
promotion_effective_discount
number
The amount of discount applied from promotional offers.
transfer_price
number
The fixed selling price applicable for payouts by the brand.
coupon_effective_discount
number
The discount applied through a coupon code, if applicable.
gst_fee
number
Total Goods and Services Tax (GST) fee charged on the goods or services.
tax_collected_at_source
number
Nullable
Tax amount collected at the source of income or transaction.
brand_calculated_amount
number
Amount calculated by the brand, possibly reflecting various costs or fees.
delivery_charge
number
Fee applicable for the delivery of the goods.
gst_tag
string
A tag used to denote GST-related attributes or classifications.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods, used in trade and commerce for uniform identification across different countries.
cashback
number
The cashback amount provided to the customer, if applicable.
item_name
string
The name or description of the item related to the financial breakup.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
cashback_applied
number
The effective cashback value that has been applied to the transaction.
cod_charges
number
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
The indicated price or value assigned to an item before any discounts or adjustments.
size
string
The size of the item, if applicable.
amount_paid
number
Total amount paid by the customer for the transaction.
coupon_value
number
The effective value of the coupon used in the transaction.
discount
number
Total amount discounted from the original price of the goods.
fynd_credits
number
Credits provided by Fynd to the customer, possibly as part of a rewards program.
gst_tax_percentage
number
The percentage of GST applicable on the goods or services.
amount_to_be_collected
number
Amount to be collected in case of multiple modes of payments.
identifiers
object (Identifier)
Show
alu
string
Nullable
The ALU (Article Level Unit) code used to identify the item at a detailed level, often specific to certain retail or distribution systems.
ean
string
Nullable
The European Article Number (EAN) is a unique identifier for products, primarily used in retail and logistics. It helps in tracking and managing inventory across various platforms.
sku_code
string
Nullable
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.
upc
string
Nullable
The Universal Product Code (UPC) is a barcode symbol used for tracking trade items in stores. It is widely used in North America and helps in identifying products quickly during point-of-sale transactions.
isbn
string
Nullable
The International Standard Book Number (ISBN) is a unique identifier for books, allowing for easier management and tracking of book inventories in retail and library systems.
total_units
integer
The total number of units involved in the transaction.
added_to_fynd_cash
boolean
Indicates whether the amount has been added to Fynd cash for future use.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Represents a detailed breakdown of a specific tax component applied to a transaction or item.
This schema provides information about the type of tax, the rate at which it is applied,
the calculated tax amount, and the base amount on which the tax is computed.
name
string
The name or type of the tax component (e.g., GST, VAT, Service Tax).
This helps in identifying the specific tax being applied to the transaction or item.
rate
number
| float
The percentage rate at which the tax is applied to the taxable amount.
This value is typically represented as a decimal (e.g., 0.18 for 18% tax).
tax_amount
number
| float
The total monetary value of the tax calculated for this component.
This is derived by applying the tax rate to the taxable amount.
taxable_amount
number
| float
The base amount on which the tax is calculated, excluding the tax itself.
This represents the value of goods or services before tax is applied.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
bag_configs
object (BagConfigs)
Show
is_returnable
boolean
Indicates whether the bag is eligible for return by the customer.
allow_force_return
boolean
A flag that determines if a forced return can be initiated for the bag.
is_active
boolean
A flag indicating whether the bag is active or not.
can_be_cancelled
boolean
A flag that determines if the bag can be cancelled.
enable_tracking
boolean
A flag that determines if shipment tracking is enabled for the bag.
is_customer_return_allowed
boolean
A flag that determines if customer return is allowed for the bag.
is_bundle_item
boolean
Flag to indicate whether the bag is part of a bundle.
bundle_details
object (BundleDetails)
Show
Contains bundle-related metadata for the shipment.
bundle_group_id
string
Unique group identifier for the bundle.
name
string
Name of the bundle.
slug
string
URL-friendly identifier for the bundle.
bundle_count
integer
Indicates bundle count of the bag.
article_bundle_id
string
Unique identifier for the article bundle.
bundle_article_quantity
integer
Article net_quantity in bundle Product.
is_base
boolean
A flag that determines if bag is base bag of bundle.
price_marked
number
Maximum Retail Price of the bundle.
price_effective
number
Current selling price of the bundle.
item_id
integer
Unique identifier for the item.
item_type
string
Type of the item (physical_bundle, virtual_bundle).
Enum
return_config
object (BundleReturnConfig)
Show
Refund Config for bundle product
allow_partial_return
boolean
Nullable
Indicates whether partial returns are allowed for bundle products.
returnable
boolean
Nullable
Indicates whether the bundle product is returnable.
unit
boolean
Nullable
Time unit for the return window (e.g., "week", "day", "hour").
time
boolean
Nullable
Duration value for the return window, expressed in the specified unit.
seller_identifier
string
Identifier for the seller of the bundle.
images
array of string
An array of image URLs associated with the bundle.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
seller_identifier
string
Nullable
delivery_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
article
object (OrderBagArticle)
Show
identifiers
object
Nullable
Details of Identifiers associated with the article.
return_config
object (ReturnConfig)
Show
returnable
boolean
Nullable
Indicates whether the article is eligible for return, allowing customers to send it back under specified conditions.
time
number
Nullable
The time frame within which the return must be initiated, typically measured in days.
unit
string
Nullable
The unit of time for the return period (e.g., days, weeks).
uid
string
Nullable
A unique identifier for the article within the order bag.
size
string
Nullable
The size of the article, which may be relevant for clothing.
tags
array of string
Nullable
An array of tags associated with the article.
_custom_json
object
Nullable
A custom JSON object containing additional details or configurations specific to the article.
brand
object (OrderBrandName)
Show
logo
string
Nullable
A URL or path to the logo image associated with the brand.
company
integer
Nullable
A unique identifier for the company associated with the brand.
id
integer
A unique identifier for the brand within the system.
created_on
string
| date-time
Nullable
Timestamp when the brand of the order was created.
brand_name
string
Nullable
The name of the brand associated with the order.
modified_on
string
| date-time
Nullable
Timestamp when the brand of the order was modified.
group_id
string
Nullable
affiliate_bag_details
object (AffiliateBagsDetails)
Show
affiliate_bag_id
string
Nullable
A unique identifier for the affiliate bag.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
item
object (PlatformItem)
Show
id
integer
Nullable
Unique identifier for the platform item.
attributes
object (PlatformArticleAttributes)
Show
currency
string
Nullable
The currency in which the price of the article is specified.
brand_id
integer
Nullable
Identifier for the brand associated with the item.
slug_key
string
Nullable
A user-friendly string that represents the item, often used in URLs.
l3_category
integer
Nullable
Represents the product's classification at the third level in the e-commerce platform's category hierarchy, using an integer identifier.
l3_category_name
string
Nullable
Name of the third-level category under which the product is listed.
last_updated_at
string
| date-time
Nullable
Timestamp when any aspect of the associated record was modified, formatted as date-time.
name
string
Nullable
The name of the product item.
l2_category
array of string
Nullable
Represents the second level of categorization for items, helping customers narrow down their search.
brand
string
Nullable
Name of the brand associated with the item.
image
array of string
Nullable
Array of image URLs representing the item.
code
string
Nullable
Unique code for the item, often used for inventory management.
l1_category
array of string
Nullable
Represents the highest or top-tier level of categorization for the product.
size
string
Nullable
Size specification of the product, if applicable.
can_cancel
boolean
Nullable
Indicates whether the item can be canceled after order placement.
can_return
boolean
Nullable
Indicates whether the item is eligible for return.
branch_url
string
Nullable
URL linking to a specific branch or store where the item is available.
meta
object
Nullable
Meta data containing additional, dynamic information about the item.
color
string
Nullable
Color specification of the product, if applicable.
department_id
integer
Nullable
Identifier for the department associated with the product.
images
array of string
Nullable
Array of image URLs representing different views or angles of the item.
tags
array of string
Nullable
Custom labels or keywords associated with the item for categorization, filtering, or business logic purposes.
payment_methods
array of object (BagPaymentMethods)
An array detailing the various payment methods utilized for the transaction. Each item within this array represents a distinct method of payment. It encapsulates the details of various payment methods available for completing a transaction. It includes comprehensive information such as the payment mode, amount, transaction status, and identifiers for each payment method.
Show
mode
string
Nullable
The payment mode used for the transaction.
amount
number
Nullable
The total amount associated with the payment method
payment_info
array of object (BagPaymentMethods)
Show
mode
string
Nullable
The payment mode used for the transaction.
amount
number
Nullable
The total amount associated with the payment method
quantity
integer
Nullable
The number of items contained in the bag.
identifier
string
Nullable
A unique identifier for the bag.
can_return
boolean
Nullable
Indicates whether the items in the bag are eligible for return by the customer.
can_cancel
boolean
Nullable
Indicates whether the bag is eligible for cancellation by the customer.
display_name
string
Nullable
A user-friendly name for the bag.
line_number
integer
Nullable
A unique identifier for each line item in a bag.
meta
object
Meta data of the bags contains additional, potentially dynamic information about the bags.
applied_promos
array of object (AppliedPromos)
Show
promotion_type
string
Nullable
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
promotion_name
string
Nullable
The name of the promotional campaign or offer.
discount_rules
array of object (DiscountRules)
A list of rules that define the conditions under which discounts are applied.
Show
value
integer
Nullable
type
string
Nullable
amount
number
Nullable
The total monetary value of the discount or promotion.
article_quantity
integer
Nullable
The quantity of articles required to qualify for the promotion.
buy_rules
array of object (BuyRules)
A list of rules that outline the conditions for purchasing items under the promotion.
Show
Rules of promotion which suffies then only the promotion is applied.
item_criteria
object (ItemCriterias)
Show
item_brand
array of integer
Nullable
cart_conditions
object
Nullable
Specifies the rules that must be met at the cart level for any purchasing rules or promotional discounts to be applied. Specifically, it includes criteria such as the total quantity of items in the cart. For instance, a rule might require that the cart contains at least one item for the promotion to apply. This setup allows for the dynamic application of discounts or special buying rules based on cart conditions.
promo_id
string
Nullable
A unique identifier for the promotion.
mrp_promotion
boolean
Nullable
A flag that designates whether or not the promotion is an MRP (manufacturer's reduced price) promotion.
applied_free_articles
array of object (AppliedFreeArticles)
A list of articles that are eligible for free under the promotion.
Show
article_id
string
A unique identifier for the article to which the free gift is applied.
free_gift_item_details
object (FreeGiftItems)
Details of the free gift item associated with the article, including relevant attributes like name, description, and any other specifications.
Show
item_slug
string
A unique identifier for the item, typically used in URLs for SEO purposes.
item_name
string
The name of the item.
item_price_details
object (ItemPriceDetails)
Show
marked
object (PriceMinMax)
Show
min
number
| float
The minimum price value. Represents the lowest price in the price range.
max
number
| float
The maximum price value. Represents the highest price in the price range.
effective
object (PriceMinMax)
Show
min
number
| float
The minimum price value. Represents the lowest price in the price range.
max
number
| float
The maximum price value. Represents the highest price in the price range.
currency
string
The currency in which the prices details associated with the item is specified.
item_brand_name
string
The brand name of the item.
item_id
integer
| int32
A unique numerical identifier for the item.
item_images_url
array of string
A list of URLs pointing to images of the item.
parent_item_identifier
string
An identifier for the parent item with which the free gift is associated, typically used to link the free gift to the original purchased item.
quantity
number
The quantity of the free gift items applied to the article.
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
current_status
object (CurrentStatus)
Show
store_id
integer
Nullable
A unique identifier for the store associated with the shipment.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number for the delivery.
kafka_sync
boolean
Nullable
A flag indicating whether the current status is synchronized with Kafka or not.
delivery_partner_id
integer
Nullable
A unique identifier for the delivery partner responsible for handling the shipment.
state_type
string
Nullable
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey, including route optimization and carrier selection.
Enum
state_id
integer
Nullable
A unique identifier for the specific state of the shipment.
id
integer
A unique identifier for the current status entry
created_at
string
| date-time
Nullable
Denotes the date and time when the bag status was created.
created_ts
string
| date-time
Nullable
A timestamp indicating when the status was created
shipment_id
string
Nullable
A unique identifier for the shipment.
updated_at
string
| date-time
Nullable
The date and time when the current status was last updated.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
A unique identifier for the bag associated with the shipment.
status
string
Nullable
A descriptive label representing the current status of the shipment.
bag_id
integer
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
is_parent
boolean
Nullable
A flag indicating whether the current bag is a parent entity or not.
dp_assignment
boolean
Nullable
Indicates whether a delivery partner has been assigned to the shipment.
total_items
integer
Nullable
The total number of items contained within the shipment,
fulfilling_store
object (FulfillingStore)
Show
phone
string
The contact phone number for the fulfilling store.
pincode
string
The postal code for the fulfilling store's location.
meta
object
Meta data of the fulfilling store contains additional, potentially dynamic information about the fulfilling store.
address
string
The complete address of the fulfilling store.
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
Display friendly version of the Fulfilment Store Address.
id
integer
The unique id or identifier of a fulfilment store.
code
string
The unique code of the fulfilment store.
store_name
string
The unique name of a fulfillment store.
country
string
The name of the country associated with a specific fulfilment store.
fulfillment_channel
string
The channel through which fulfillment is managed.
contact_person
string
The name of the contact person associated with a fulfilling store.
state
string
The state or region where the fulfilling store is located.
city
string
The city in which the fulfilling store is situated.
store_email
string
Nullable
The email address of the fulfilling store.
meta
object
Meta data of the shipment contains additional, potentially dynamic information about the shipment.
pdf_links
object
PDF Links associated with the shipment.
payment_mode
string
Nullable
The mode of payment used for the shipment.
packaging_type
string
Nullable
Defines the type of packaging used for the product, encompassing materials, design, and form factors.
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
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
An array of charges applied to the shipment.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
vertical
string
Nullable
The business vertical or category to which the shipment belongs.
shipment_id
string
A unique identifier for the shipment.
payments
object (ShipmentPayments)
Show
mode
string
Nullable
The payment mode used for the shipment.
logo
string
Nullable
A URL or path to the logo associated with the payment method.
source
string
Nullable
The source or origin of the payment
operational_status
string
Nullable
The operational status of the shipment.
status
object (ShipmentStatusData)
Show
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
bag_list
array of string
Nullable
The list of bags that are in this shipment status transition.
id
integer
Nullable
Unique identifier for a shipment status.
created_at
string
| date-time
Nullable
Denotes the date and time when the transition was created.
created_ts
string
Nullable
A timestamp indicating when the status entry was created.
shipment_id
string
Nullable
The unique identifier for the shipment.
status
string
Nullable
The current status of the shipment.
display_name
string
Nullable
A user-friendly name or description of the current shipment status.
current_shipment_status
string
Nullable
Reflects the most recent status of the shipment.
status_created_at
string
| date-time
Nullable
Denotes the date and time when the transition of the status of the shipment was created.
total_bags
integer
Nullable
The total number of bags in the shipment.
shipment_created_at
string
| date-time
Nullable
Denotes the date and time when the shipment was created.
shipment_created_ts
string
Nullable
A timestamp representing when the shipment was created.
currency
object (Currency)
Show
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.
currency_symbol
string
The symbol representing the currency.
currency_info
object (CurrencyInfo)
Show
ordering_currency
object (OrderingCurrency)
Show
currency_code
string
This specifies the currency code for all amounts.
currency_name
string
The full name of the currency.
currency_symbol
string
The symbol representing the currency.
currency_sub_unit
string
The sub-unit of the currency
conversion_rate
object (ConversionRate)
Show
base
string
The base currency code, example 'INR' for Indian Rupee, against which all conversion rates are calculated. Follows the ISO 4217 standard.This includes the currency's name, its conversion rate relative to the base currency ('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency conversion but also enriches the data with useful currency descriptors, enhancing financial operations and analyses.
rates
object
An object , where each key is a currency code and its value is an object containing detailed information
about that currency. This includes the currency's name, its conversion rate relative to the base currency
('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency
conversion but also enriches the data with useful currency descriptors.
previous_shipment_id
string
Nullable
The ID of the previous shipment in the sequence.
shipment_update_time
number
Nullable
A numerical representation of the last update time for the shipment
rto_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
credit_note_id
string
Nullable
The identifier for any credit note issued for the shipment
is_self_ship
boolean
Nullable
A flag indicating whether the shipment is being self-shipped by the seller or vendor.
mode_of_payment
string
Nullable
The specific mode of payment used for the transaction
is_lapa_enabled
boolean
Flag to show NDR actions based on LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true, else false.
forward_end_shipment_id
string
Nullable
The forward_end_shipment_id represents the shipment ID of the original forward journey shipment. When a shipment is transitioned to a return journey, the original shipment ID from the forward journey is recorded in the forward_end_shipment_id field of the return journey shipment. Even if the return shipment is later split into multiple shipments, each of these shipments will retain the same forward_end_shipment_id value that was assigned during the initial return journey initiation. This ensures that all return shipments can be traced back to the original forward journey shipment.
logistics_meta
object
An object storing detailed logistics-related information, including courier partner details and other relevant metadata.
packages
array of object (PackageSchema)
Array of packages to be created or updated for the shipment. At least two packages are required for MPS functionality.
Show
id
string
Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.
packaging_id
string
Nullable
Optional reference to a predefined packaging configuration or template used for creating physical packages.
name
string
Nullable
A human-readable name or label for the package, used for identification and organizational purposes.
size
string
Nullable
The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.
package_type
string
Nullable
The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).
length
number
| float
Nullable
The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
width
number
| float
Nullable
The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
height
number
| float
Nullable
The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
weight
number
| float
Nullable
The actual weight of the package in kilograms, including packaging materials and products.
error_rate
number
| float
Nullable
The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).
package_vol_weight
number
| float
Nullable
The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.
max_weight
number
| float
Nullable
The maximum weight capacity that this package can handle, used for validation and logistics planning.
awb
string
Nullable
Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.
pdf_links
object
Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.
Default Value : [object Object]
products
array of object (PackageProduct)
List of products contained within this package. Each product specifies its line number, quantity, and identifier.
Show
line_number
integer
The line number of the product within the shipment, used for tracking and identification purposes.
quantity
number
The quantity of the product included in this package.
identifier
string
The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.
Examples
Parameters
company_id:
1
order_id:
"value"
my_orders:
false
allow_inactive:
false
Response
Get order
getOrderById
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
Default Value : 37
lanequery
string
lane refers to a section where orders are assigned, indicating its grouping.
Enum
search_typequery
string
search_type refers to the field that will be used as the target for the search operation.
Enum
bag_statusquery
string
bag_status refers to status of the entity. Filters orders based on the status.
time_to_dispatchquery
integer
time_to_dispatch refers to estimated SLA time.
Enum
payment_methodsquery
string
Comma separated values of payment methods that were used to place order.
tagsquery
string
tags refers to additional descriptive labels associated with the order
search_valuequery
string
search_value is matched against the field specified by the search_type
Default Value : 16854460524441037000
from_datequery
string
| date
Date time in UTC timezone as per ISO format.
to_datequery
string
| date
Date time in UTC timezone as per ISO format.
start_datequery
string
| date-time
Date time in UTC timezone as per ISO format.
end_datequery
string
| date-time
Date time in UTC timezone as per ISO format.
dp_idsquery
string
Delivery Partner IDs to which shipments are assigned.
storesquery
string
A comma-separated list of store IDs used to filter results to only those related to specific stores.
sales_channelsquery
string
A comma-separated list of sales channel IDs to filter results based on the sales channels involved.
page_noquery
integer
Specifies the page number for paginated results.
Default Value : 1
page_sizequery
integer
Determines the number of results returned per page.
Default Value : 10
is_priority_sortquery
boolean
Default Value : true
custom_metaquery
string
Default Value : 6388422a5ebd6a6cf4a8ede6
my_ordersquery
boolean
show_cross_company_dataquery
boolean
Flag to view cross & non-cross company order
Default Value : false
customer_idquery
string
The unique identifier for the customer associated with the query, useful for filtering results to a specific customer.
order_typequery
string
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
allow_inactivequery
boolean
Flag indicating whether inactive shipments are allowed
Default Value : false
group_entityquery
string
Defines the grouping criterion for retrieving shipments or orders. It specifies whether the results should be organized based on shipment groups or order groups. For example, using 'shipments' groups results by shipment, while an invalid value like 'abcd' may not be recognized, leading to errors or default behavior.
enforce_date_filterquery
boolean
Applies a date filter for listing orders. This is useful when fetching data for a specific date range while performing searches.
Default Value : false
fulfillment_typequery
string
Define the Fulfillment Type for Listing Orders, This is use when we want to get list of shipments or orders by cross store or cross company or fulfilling Store (by default), this is also depends on the login user accessType and store access
Enum
ordering_sourcequery
string
Filter orders by ordering source. Accepts comma-separated values for multiple sources.
channel_account_idquery
string
Comma-separated channel account IDs to filter orders by specific channel accounts.
GET
Response
200
We are processing the report!
Hide
total_count
integer
Nullable
The total number of orders matching the query criteria.
message
string
Nullable
A message providing additional context about the response.
success
boolean
Nullable
Indicates whether the API call was successful (true) or not (false).
items
array of object (PlatformOrderItems)
An array of shipment items returned as part of the response.
Show
breakup_values
array of object (PlatformBreakupValues)
The breakup_values array contains detailed breakdowns of different pricing components related to an order. Each item in the array is a reference to the PlatformBreakupValues schema, which provides specific details about each component such as loyalty points, coupon discounts, raw pricing data, and display information.
Show
value
string
Nullable
Represents the value associated with a specific component of the price breakdown.
name
string
Nullable
Represents the name associated with a specific component of the price breakdown.
display
string
Nullable
A user-friendly display name for the component, intended for presentation in user interfaces.
total_order_value
number
Nullable
meta
object
Nullable
It contains the additional properties related to order transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic, potentially.
order_created_time
string
Nullable
The Date and time when the order was created.
order_created_ts
string
Nullable
The timestamp indicating when the order was created.
ordering_source
string
Nullable
Ordering source, to be used to identify source of order creation.
ordering_source_details
object (OrderingSourceDetails)
Show
type
string
Type of the ordering source.
Enum
slug
string
Slug identifier of the ordering source.
display_name
string
Display name of the ordering source.
is_active
boolean
Indicates whether the ordering source is active.
logo
string
| uri
Logo URL of the ordering source.
payment_mode
string
Nullable
The payment mode used for the order.
shipments
array of object (PlatformShipment)
An array of shipment items returned as part of the order.
Show
fulfillment_option
object (FulfillmentOption)
Show
name
string
slug
string
type
string
is_default
boolean
picked_date
string
| date-time
Nullable
Indicates the date and time when the shipment was physically picked up from the sender or the origin point by the delivery service. This timestamp is crucial for tracking the commencement of the shipment's journey.
tracking_list
array of object (TrackingList)
A list of tracking updates associated with the shipment.
Show
is_passed
boolean
Nullable
A flag indicating whether the tracking event has already occurred. If true, it means the event is in the past; otherwise, it is either current or future.
text
string
A descriptive message or status update associated with the tracking event, providing context about the shipment's progress or condition.
is_current
boolean
Nullable
A flag indicating whether this tracking event is the most recent update. If true, it reflects the latest status of the shipment.
time
string
Nullable
A timestamp representing when the tracking event occurred. This helps in understanding the timeline of the shipment's journey.
created_ts
string
Nullable
A timestamp indicating when the tracking information was created or logged in the system. This may differ from the event time.
status
string
The specific status associated with the tracking event, such as "In Transit," "Delivered," or "Out for Delivery," providing clarity on the shipment's current phase.
invoice
object (InvoiceInfo)
Show
store_invoice_id
string
Nullable
A unique identifier for the invoice generated by the store or platform, used for internal tracking and reference.
invoice_url
string
Nullable
A URL linking to the digital version of the invoice, allowing users to view or download the invoice document online.
updated_date
string
| date-time
Nullable
Denotes the date and time when the invoice information was modified or updated, providing a record of the most recent changes.
external_invoice_id
string
Nullable
An identifier for the invoice used by external systems or partners, facilitating cross-system tracking and reconciliation.
label_url
string
Nullable
A URL linking to the shipping label associated with the invoice, which may be used for shipment tracking and logistics.
credit_note_id
string
Nullable
The identifier for any credit note related to the invoice, used in cases of refunds or adjustments to the original billing.
links
object
An object containing additional links relevant to the invoice, which may include related documents or resources.
shipment_status
string
Nullable
Represents the current status of the shipment.
gst_details
object (GSTDetailsData)
Show
cgst_tax_percentage
number
Nullable
The percentage of Central Goods and Services Tax (CGST) applicable on the goods or services.
gstin_code
string
Nullable
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.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
gst_fee
number
The total GST fee charged on the goods or services.
igst_tax_percentage
number
Nullable
The percentage of Integrated Goods and Services Tax (IGST) applicable for inter-state transactions.
gst_tax_percentage
number
Nullable
The overall GST tax percentage applicable to the goods or services.
hsn_code_id
string
Nullable
Unique identifier for the Harmonized System of Nomenclature (HSN) code used to classify goods.
igst_gst_fee
number
Nullable
The GST fee applicable for IGST, usually for inter-state transactions.
is_default_hsn_code
boolean
Nullable
Indicates whether this HSN code is the default classification for the goods.
sgst_gst_fee
number
Nullable
The GST fee applicable for State Goods and Services Tax (SGST).
tax_collected_at_source
number
Tax amount collected at the source of income or transaction, often for compliance and revenue tracking.
brand_calculated_amount
number
Amount calculated by the brand, potentially reflecting costs, fees, or pricing structures.
cgst_gst_fee
number
Nullable
The GST fee applicable for CGST.
gst_tag
string
Nullable
A tag or label used to denote GST-related attributes or classifications.
sgst_tax_percentage
number
Nullable
The percentage of State Goods and Services Tax (SGST) applicable on the goods or services.
hsn_code
string
Nullable
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.
order_status
object (OrderStatusData)
Show
Object that contains delivery status information, including a descriptive label, time information, color code for visual representation, and the expected delivery date.
order_details
object (OrderDetails)
Show
fynd_order_id
string
created_at
string
| date-time
Date and time when the order was created.
user_id
string
Nullable
tax_details
object (TaxDetails)
Show
pan_no
string
Nullable
gstin
string
Nullable
mongo_cart_id
number
Nullable
delivery_charges
number
Nullable
transaction_id
string
Nullable
collect_by
string
headers
object
Nullable
Header details of the order.
coupon_value
number
Nullable
order_value
number
created_time
string
currency
string
The currency in which the prices details associated with the item is specified.
total_order_value
number
ordering_channel
string
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
meta
object
Nullable
Meta data of the order data contains additional, potentially dynamic information about the order data.
cod_charges
number
Nullable
cashback_value
number
Nullable
refund_by
string
affiliate_order_date
string
| date-time
Nullable
Specifies the date and time of the order when it was created within the affiliate's system. It specifies that the date and time are recorded in ISO 8601 format.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. The structure is designed to accommodate any number of payment methods,providing flexibility and comprehensive insights into each transaction's payment aspect.
affiliate_order_id
string
payment_mode_id
number
Nullable
promotion_effective_discount
number
Nullable
mode_of_payment
string
discount
number
Nullable
cashback_applied
number
Nullable
fynd_credits
number
Nullable
affiliate_id
string
ordering_channel_logo
string
Nullable
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
loyalty_discount_details
object (LoyaltyDiscountDetails)
Show
Object containing detailed information about the loyalty discount applied during an order.
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed.
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace.
Enum
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order.
errors
array of string
A list of any errors that occurred while attempting to obtain the order's status.
shipment_details
array of object (ShipmentDetail)
A list of the individual shipments associated with the order and their current statuses.
Show
shipment_id
string
Unique identifier for the shipment associated with the order.
status
string
A string representing the current status of the shipment
id
integer
| int32
An integer that serves as a unique identifier for the shipment detail
bag_list
array of integer
A list of bag identifiers associated with the shipment.
meta
object (Meta)
Show
kafka_emission_status
integer
| int32
An integer representing the status of the message upon emission to Kafka. 0 indicates success, while 1 indicates failure.
state_manager_used
string
A string that specifies the state manager utilized for handling the order's state.
remarks
string
A string for any additional comments or notes related to the shipment,
text
string
A label or description of the delivery status, such as 'Expected Delivery Date'.
value
string
The detailed delivery status or time information, such as 'Arriving on 24 Nov 2022 15:54:00'.
color_code
string
Hex code for the color representing the delivery status.
expected_delivery_date
string
| date-time
The ISO 8601 formatted date and time when the delivery is expected, e.g., '2022-11-24T22:15:54+00:00'.
delivery_slot
object
Nullable
Represents a specific time window allocated for the delivery of an order or shipment.
order
object (OrderDetailsData)
Show
order_date
string
| date-time
Nullable
Represents the date and time when the order was placed by the customer. This timestamp is essential for tracking the initiation of the order process, scheduling deliveries, and analyzing order timelines.
created_ts
string
Nullable
A timestamp indicating when the order was created in the system.
tax_details
object
Nullable
Contains a flexible and comprehensive set of key-value pairs detailing the tax calculations and classifications applicable to the order.
cod_charges
string
Nullable
The charges associated with Cash on Delivery (COD) payments.
source
string
Nullable
The source from which the order originated.
fynd_order_id
string
An unique identifier for the order.
affiliate_id
string
Nullable
Affiliate id associated with order.
affiliate_order_id
string
Nullable
Affiliate order id associated with order.
ordering_channel_logo
object
Nullable
Represents the logo of the channel through which the order was placed, encapsulating branding elements and any relevant styling attributes. This object is designed to be flexible, allowing for the inclusion of various properties that define how the logo should be displayed across different platforms or documents related to the order.
order_value
string
Nullable
The total monetary value of the order
ordering_channel
string
Nullable
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
loyalty_discount_details
object (LoyaltyDiscountDetails)
Show
Object containing detailed information about the loyalty discount applied during an order.
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed.
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace.
Enum
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order.
meta
object
Meta data of the order contains additional, potentially dynamic information about the order.
user
object (UserDataInfo)
Show
Contains the details of the user who created the order including identifying information and relevant metadata.
id
integer
Nullable
The unique identifier associated with the user.
user_oid
string
Nullable
The object ID for the user, used for referencing the user in various operations.
mongo_user_id
string
Nullable
The identifier for the user.
external_customer_id
string
Nullable
The identifier for the user in external systems.
first_name
string
Nullable
The first name of the user.
last_name
string
Nullable
The last name of the user.
mobile
string
Nullable
The mobile phone number of the user.
email
string
Nullable
The email address of the user.
meta
object
Nullable
Additional metadata related to the user.
is_anonymous_user
boolean
Nullable
Indicates whether the user is an anonymous user (true) or registered (false).
name
string
Nullable
A full name of the user, which may be a combination of first and last name.
gender
string
Nullable
The gender of the user.
country_phone_code
string
The country-specific phone code, useful for formatting mobile numbers correctly.
enable_dp_tracking
boolean
Nullable
A flag indicating whether the delivery partner tracking feature is enabled for this shipment.
custom_message
string
Nullable
A custom message or note associated with the shipment.
estimated_sla_time
string
Nullable
The estimated service level agreement (SLA) time for the shipment, indicating expected delivery timelines.
estimated_sla_ts
string
Nullable
A timestamp indicating when the estimated SLA time is expected to be met.
can_update_dimension
boolean
Nullable
Indicates whether the dimensions of the shipment can be updated after creation.
shipment_images
array of string
Nullable
A list of URLs for images related to the shipment.
delivery_details
object
A list of details about the delivery of an order.
billing_details
object
Information regarding the billing for the shipment, including billing address and payment method.
forward_shipment_id
string
Nullable
The ID of the parent forward journey shipment.
fulfilment_priority
integer
Nullable
The fulfilment priority, with lower numbers indicating a higher priority.
shipment_details
object (ShipmentLockDetails)
Show
lock_status
boolean
Nullable
Represents the lock status of the shipment.
lock_message
string
Nullable
A user-friendly message that explains the reason for locking the shipment.
action_to_status
object
Nullable
This field maps potential actions (e.g., downloading an invoice or label) to their corresponding shipment lock statuses, indicating which operations are allowed depending on the shipment's current lock status. When an action is set to 'lock', it means no transitions or updates to the shipment's status can be performed until the specified action is completed. For instance, if 'download_invoice' is in a 'lock' state, the shipment cannot undergo any status transitions until the invoice is either downloaded. Similarly, 'download_label' being in a 'lock' state prevents any shipment status transitions until a new label is downloaded.
custom_meta
array of object
Nullable
An array of custom metadata objects that may contain additional, dynamic information specific to the shipment.
shipment_quantity
integer
Nullable
The total quantity of items included in the shipment.
company_details
object (CompanyDetails)
Show
company_name
string
Nullable
The name of the company.
address
object
Nullable
It contains the properties for the address of a company.
company_cin
string
Nullable
The Corporate Identification Number (CIN) of the company.
company_id
integer
Nullable
A unique identifier for the company on the platform.
company_gst
string
Nullable
The Goods and Services Tax (GST) number of the company.
company_contact
object (ContactDetails)
Show
phone
array of object (PhoneDetails)
Nullable
An array of phone numbers associated with the contact.
Show
country_code
integer
Nullable
Identifies the country of the user's phone number using the two-character standard ISO 3166-1 alpha-2 country codes. Examples include 'US' for the United States and 'IN' for India.
number
string
Nullable
The actual phone number of the user.
emails
array of string
Nullable
An array of email addresses associated with the contact.
ordering_store
object (OrderingStoreDetails)
Show
phone
string
Nullable
The contact phone number for the ordering store.
pincode
string
Nullable
The postal code associated with the ordering store's location.
meta
object
Nullable
Meta data of the ordering store contains additional, potentially dynamic information about the ordering store.
address
string
Nullable
The complete address of the ordering store.
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
Formatted address based on the title-template provided by the partner.
id
integer
Nullable
A unique identifier for the ordering store.
code
string
Nullable
A specific code associated with the ordering store.
store_name
string
Nullable
The name of the ordering store.
country
string
Nullable
The country in which the ordering store is located.
contact_person
string
Nullable
The name of the primary contact person at the ordering store.
state
string
Nullable
The state or region where the ordering store is situated.
city
string
Nullable
The city in which the ordering store is located.
name
string
Nullable
The name of the ordering store.
store_email
string
Nullable
The email address of the ordering store.
order_platform
string
The platform used to place the order.
lock_status
boolean
Nullable
Indicates whether the shipment is currently locked or not for modifications or updates.
platform_logo
string
Nullable
The URL of the ordering platform's logo.
user_agent
string
Nullable
Information about the user agent string, typically containing details about the browser or application used to place the order.
dp_details
object (DPDetailsData)
Show
pincode
string
Nullable
The postal code associated with the delivery partner's location
track_url
string
Nullable
A URL that provides access to real-time tracking information for the shipment.
eway_bill_id
string
Nullable
The unique identifier for the e-way bill generated for the shipment.
id
integer
Nullable
A unique identifier for the delivery partner details.
country
string
Nullable
The country in which the delivery partner operates.
awb_no
string
Nullable
The Air Waybill number, a tracking number used for air freight shipments, allowing for the identification and tracking of the package in transit.
gst_tag
string
Nullable
A tag associated with the Goods and Services Tax (GST) for the shipment.
name
string
Nullable
The name of the delivery partner or service provider responsible for transporting the shipment.
invoice_id
string
Nullable
The unique identifier for the invoice associated with the shipment.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. The structure is designed to accommodate any number of payment methods,providing flexibility and comprehensive insights into each transaction's payment aspect.
payment_info
array of object
Nullable
An array of objects containing detailed information about the payments made for the shipment.
coupon
object
Nullable
Coupon data of the shipment which denotes if coupon is applied, coupon code, coupon amount, coupon title and coupon message.
affiliate_details
object (AffiliateDetails)
Show
Details of an affiliate associated with a shipment.
shipment_meta
object (ShipmentMeta)
Show
tracking_url
string
Nullable
A URL for tracking the shipment.
estimated_delivery_date
string
| date-time
Nullable
Provides a forecasted date and time by which the shipment is expected to be delivered to the recipient. This estimation is crucial for planning purposes, both for the sender in managing expectations and for the recipient in preparing for receipt.
same_store_available
boolean
Indicates whether the shipment is available for pickup from the same store.
b2b_buyer_details
object (BuyerDetails)
Show
ajio_site_id
string
Nullable
The unique identifier for the buyer on the Ajio platform.
pincode
integer
The postal code for the buyer's shipping address, used for delivery location identification.
address
string
Provides the comprehensive address details of the buyer's shipping address.
gstin
string
The Goods and Services Tax Identification Number (GSTIN) of the buyer.
name
string
The full name of the buyer, essential for personalizing communication and delivery.
state
string
The name of the state where the buyer's shipping address is located, important for logistical purposes.
city
string
The name of the city where the buyer's shipping address is located, which helps in identifying delivery zones.
formatted
object (Formatted)
Show
max
string
Nullable
Represents the maximum formatted value, providing a limit for the associated data, such as dimensions or weights.
min
string
Nullable
Represents the minimum formatted value, establishing a lower limit for the associated data, ensuring it meets certain criteria or standards.
debug_info
object (DebugInfo)
Show
stormbreaker_uuid
string
Nullable
A unique identifier (UUID) associated with the Stormbreaker system, used for tracking and debugging purposes in the application.
return_awb_number
string
Nullable
The Air Waybill (AWB) number associated with a return shipment.
is_self_ship
boolean
Nullable
Indicates whether the shipment is a self-shipped order.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
einvoice_info
object (EinvoiceInfo)
Show
credit_note
object
Nullable
Specifies the reverse einvoice transaction create on government portal.
invoice
object
Nullable
It specifies the forward einvoice transaction created on government portal.
return_affiliate_shipment_id
string
Nullable
The shipment ID associated with a return from an affiliate.
parent_dp_id
string
Nullable
The unique identifier for the parent delivery partner.
shipment_weight
number
Nullable
The total weight of the shipment.
dimension
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment.
assign_dp_from_sb
boolean
Nullable
Indicates whether to assign the delivery partner from the store’s basket.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
store_invoice_updated_date
string
| date-time
Nullable
Denotes the date and time when the store's invoice related to this shipment was updated. This timestamp is vital for tracking changes to billing details, adjustments in charges, or updates in the invoicing status.
forward_affiliate_shipment_id
string
Nullable
The shipment ID for the forward journey of an affiliate shipment.
return_store_node
integer
Nullable
The identifier for the store node involved in the return process.
fulfilment_priority_text
string
Nullable
Textual representation of the fulfillment priority for the shipment.
shipment_tags
array of object (ShipmentTags)
Tags associated with the shipment for categorization and filtering.
Show
slug
string
Nullable
A URL-friendly string representing the tag, often used for routing or categorization.
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
display_text
string
Nullable
A human-readable text representation of the tag, used for display purposes in user interfaces.
external
object
Nullable
External metadata related to the shipment.
awb_number
string
Nullable
The Air Waybill number associated with the shipment.
lock_data
object (LockData)
Show
locked
boolean
Nullable
Indicates whether the shipment is currently locked for processing (true) or not (false).
mto
boolean
Nullable
A flag indicating whether the shipment is part of a multi-modal transport operation.
lock_message
string
Nullable
An optional message providing additional context or information regarding the lock status.
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.
Enum
ewaybill_info
object
Nullable
Electronic Way Bill details i.e ewayBillNo, ewayBillDate that are utilized in the transportation of goods.
dp_id
string
Nullable
The unique identifier for the delivery partner associated with the shipment.
shipment_volumetric_weight
number
Nullable
The volumetric weight of the shipment, which may differ from its actual weight.
marketplace_store_id
string
Nullable
The unique identifier for the marketplace store associated with the shipment.
return_details
object
Nullable
An object containing the return details of the shipment.
dp_sort_key
string
Nullable
A sort key for the delivery partner, used for prioritization.
packaging_name
string
Nullable
The name of the packaging used for the shipment.
timestamp
object (ShipmentTimeStamp)
Show
max
integer
Nullable
Represents the maximum timestamp value, indicating the latest time relevant to the shipment.
min
integer
Nullable
Represents the minimum timestamp value, indicating the earliest time relevant to the shipment.
auto_trigger_dp_assignment_acf
boolean
Nullable
Indicates whether automatic delivery partner assignment is triggered for this shipment.
dp_name
string
Nullable
The name of the delivery partner associated with the shipment.
po_number
string
Nullable
The purchase order number associated with the shipment.
weight
integer
The weight of the shipment, typically measured in grams or kilograms.
b2c_buyer_details
object
Nullable
Contains detailed information about the buyer in a business-to-consumer (B2C) transaction. This object is designed to capture a wide array of buyer-specific data such as contact information, shipping address, preferences, and any other relevant details that enhance the understanding of the buyer's profile and needs.
forward_affiliate_order_id
string
Nullable
The order ID for the forward journey of an affiliate shipment.
return_affiliate_order_id
string
Nullable
The order ID for the return journey of an affiliate shipment.
bag_weight
object
Nullable
This object is designed to accommodate a range of weight-related information. Denotes the weight of the bag, potentially including various measurements or related details.
refund_to
string
Nullable
Specifies the recipient of any refunds related to the shipment.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_shipment_id
string
The shipment ID specific to this affiliate.
company_affiliate_tag
string
Nullable
An optional tag representing the company's affiliate association.
affiliate_order_id
string
The order ID associated with the affiliate shipment.
pdf_links
object (PDFLinks)
Show
invoice_type
string
The type of invoice issued, such as 'fynd' or other classifications.
Enum
label_a6
string
Nullable
URL or path to the A6 size label document.
invoice
string
Nullable
URL or path to the main invoice document.
label_pos
string
Nullable
URL or path to the POS label document.
invoice_a6
string
Nullable
URL or path to the A6 size invoice document.
b2b
string
Nullable
URL or path to the B2B document related to the transaction.
label
string
Nullable
URL or path to the general label document.
label_a4
string
Nullable
URL or path to the A4 size label document.
label_type
string
Specifies the type of label associated with a PDF document,indicating its purpose or content. The label_type helps in organizing and identifying PDF documents quickly, ensuring that users or systems can efficiently utilize the correct documents for required actions.
Enum
invoice_export
string
Nullable
URL or path to the exported invoice document.
credit_note_url
string
Nullable
URL or path to the credit note document.
delivery_challan_a4
string
Nullable
URL or path to the A4 delivery challan document.
label_export
string
Nullable
URL or path to the exported label document.
invoice_a4
string
Nullable
URL or path to the A4 size invoice document.
invoice_pos
string
Nullable
URL or path to the POS invoice document.
po_invoice
string
Nullable
URL or path to the purchase order invoice document.
config
object (AffiliateConfig)
Show
app
object (AffiliateAppConfig)
Show
id
string
description
string
updated_at
string
| date-time
The date and time when the app config was updated.
name
string
token
string
meta
array of object (AffiliateAppConfigMeta)
Show
value
string
name
string
owner
string
secret
string
created_at
string
| date-time
Timestamp when the app config was created.
inventory
object (AffiliateInventoryConfig)
Show
article_assignment
object (AffiliateInventoryArticleAssignmentConfig)
Show
post_order_reassignment
boolean
payment
object (AffiliateInventoryPaymentConfig)
Show
source
string
mode_of_payment
string
inventory
object (AffiliateInventoryStoreConfig)
Show
store
object
Fulfilling store information related to the shipment.
order
object (AffiliateInventoryOrderConfig)
Show
force_reassignment
boolean
logistics
object (AffiliateInventoryLogisticsConfig)
Show
dp_assignment
boolean
app_company_id
integer
Nullable
A unique identifier for the company associated with the affiliate app, used for tracking and managing affiliate relationships.
affiliate_id
string
Nullable
The unique identifier for the affiliate.
affiliate_store_id
string
The unique identifier for the affiliate's store.
affiliate_bag_id
string
The unique identifier for the affiliate's bag.
id
string
Nullable
The unique identifier for the affiliate.
priority_text
string
Nullable
Text that indicates the priority level of the shipment.
bag_status_history
array of object (BagStatusHistory)
A history of status changes for bags associated with the shipment.
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
is_dp_assign_enabled
boolean
Nullable
A flag indicating whether delivery partner assignment features are enabled for the shipment.
bags
array of object (OrderBags)
A list of bags included in the shipment
Show
gst_details
object (GSTDetailsData)
Show
cgst_tax_percentage
number
Nullable
The percentage of Central Goods and Services Tax (CGST) applicable on the goods or services.
gstin_code
string
Nullable
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.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
gst_fee
number
The total GST fee charged on the goods or services.
igst_tax_percentage
number
Nullable
The percentage of Integrated Goods and Services Tax (IGST) applicable for inter-state transactions.
gst_tax_percentage
number
Nullable
The overall GST tax percentage applicable to the goods or services.
hsn_code_id
string
Nullable
Unique identifier for the Harmonized System of Nomenclature (HSN) code used to classify goods.
igst_gst_fee
number
Nullable
The GST fee applicable for IGST, usually for inter-state transactions.
is_default_hsn_code
boolean
Nullable
Indicates whether this HSN code is the default classification for the goods.
sgst_gst_fee
number
Nullable
The GST fee applicable for State Goods and Services Tax (SGST).
tax_collected_at_source
number
Tax amount collected at the source of income or transaction, often for compliance and revenue tracking.
brand_calculated_amount
number
Amount calculated by the brand, potentially reflecting costs, fees, or pricing structures.
cgst_gst_fee
number
Nullable
The GST fee applicable for CGST.
gst_tag
string
Nullable
A tag or label used to denote GST-related attributes or classifications.
sgst_tax_percentage
number
Nullable
The percentage of State Goods and Services Tax (SGST) applicable on the goods or services.
hsn_code
string
Nullable
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.
bag_status
array of object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
parent_promo_bags
object
Nullable
An object containing details of parent promotional bags.
seller_qc_details
object (SellerQcDetails)
Nullable
Show
Provides the seller's quality control details for a bag while accepting return items, including the line number reference and the quantities of items that passed or failed QC.
line_number
integer
Represents the line number in an order or transaction associated with the bag.
bad_quantity
integer
Represents the total number of items in a bag that have failed quality control and are marked as bad QC.
good_quantity
integer
Represents the total number of items in a bag that have passed quality control and are marked as good QC.
financial_breakup
object (FinancialBreakup)
Show
refund_credit
number
The amount of refund credits applicable for the transaction.
amount_paid_roundoff
integer
Nullable
Total amount paid, rounded off to the nearest integer for billing purposes.
price_effective
number
The effective price after applying discounts and before any taxes.
promotion_effective_discount
number
The amount of discount applied from promotional offers.
transfer_price
number
The fixed selling price applicable for payouts by the brand.
coupon_effective_discount
number
The discount applied through a coupon code, if applicable.
gst_fee
number
Total Goods and Services Tax (GST) fee charged on the goods or services.
tax_collected_at_source
number
Nullable
Tax amount collected at the source of income or transaction.
brand_calculated_amount
number
Amount calculated by the brand, possibly reflecting various costs or fees.
delivery_charge
number
Fee applicable for the delivery of the goods.
gst_tag
string
A tag used to denote GST-related attributes or classifications.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods, used in trade and commerce for uniform identification across different countries.
cashback
number
The cashback amount provided to the customer, if applicable.
item_name
string
The name or description of the item related to the financial breakup.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
cashback_applied
number
The effective cashback value that has been applied to the transaction.
cod_charges
number
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
The indicated price or value assigned to an item before any discounts or adjustments.
size
string
The size of the item, if applicable.
amount_paid
number
Total amount paid by the customer for the transaction.
coupon_value
number
The effective value of the coupon used in the transaction.
discount
number
Total amount discounted from the original price of the goods.
fynd_credits
number
Credits provided by Fynd to the customer, possibly as part of a rewards program.
gst_tax_percentage
number
The percentage of GST applicable on the goods or services.
amount_to_be_collected
number
Amount to be collected in case of multiple modes of payments.
identifiers
object (Identifier)
Show
alu
string
Nullable
The ALU (Article Level Unit) code used to identify the item at a detailed level, often specific to certain retail or distribution systems.
ean
string
Nullable
The European Article Number (EAN) is a unique identifier for products, primarily used in retail and logistics. It helps in tracking and managing inventory across various platforms.
sku_code
string
Nullable
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.
upc
string
Nullable
The Universal Product Code (UPC) is a barcode symbol used for tracking trade items in stores. It is widely used in North America and helps in identifying products quickly during point-of-sale transactions.
isbn
string
Nullable
The International Standard Book Number (ISBN) is a unique identifier for books, allowing for easier management and tracking of book inventories in retail and library systems.
total_units
integer
The total number of units involved in the transaction.
added_to_fynd_cash
boolean
Indicates whether the amount has been added to Fynd cash for future use.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Represents a detailed breakdown of a specific tax component applied to a transaction or item.
This schema provides information about the type of tax, the rate at which it is applied,
the calculated tax amount, and the base amount on which the tax is computed.
name
string
The name or type of the tax component (e.g., GST, VAT, Service Tax).
This helps in identifying the specific tax being applied to the transaction or item.
rate
number
| float
The percentage rate at which the tax is applied to the taxable amount.
This value is typically represented as a decimal (e.g., 0.18 for 18% tax).
tax_amount
number
| float
The total monetary value of the tax calculated for this component.
This is derived by applying the tax rate to the taxable amount.
taxable_amount
number
| float
The base amount on which the tax is calculated, excluding the tax itself.
This represents the value of goods or services before tax is applied.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
bag_configs
object (BagConfigs)
Show
is_returnable
boolean
Indicates whether the bag is eligible for return by the customer.
allow_force_return
boolean
A flag that determines if a forced return can be initiated for the bag.
is_active
boolean
A flag indicating whether the bag is active or not.
can_be_cancelled
boolean
A flag that determines if the bag can be cancelled.
enable_tracking
boolean
A flag that determines if shipment tracking is enabled for the bag.
is_customer_return_allowed
boolean
A flag that determines if customer return is allowed for the bag.
is_bundle_item
boolean
Flag to indicate whether the bag is part of a bundle.
bundle_details
object (BundleDetails)
Show
Contains bundle-related metadata for the shipment.
bundle_group_id
string
Unique group identifier for the bundle.
name
string
Name of the bundle.
slug
string
URL-friendly identifier for the bundle.
bundle_count
integer
Indicates bundle count of the bag.
article_bundle_id
string
Unique identifier for the article bundle.
bundle_article_quantity
integer
Article net_quantity in bundle Product.
is_base
boolean
A flag that determines if bag is base bag of bundle.
price_marked
number
Maximum Retail Price of the bundle.
price_effective
number
Current selling price of the bundle.
item_id
integer
Unique identifier for the item.
item_type
string
Type of the item (physical_bundle, virtual_bundle).
Enum
return_config
object (BundleReturnConfig)
Show
Refund Config for bundle product
allow_partial_return
boolean
Nullable
Indicates whether partial returns are allowed for bundle products.
returnable
boolean
Nullable
Indicates whether the bundle product is returnable.
unit
boolean
Nullable
Time unit for the return window (e.g., "week", "day", "hour").
time
boolean
Nullable
Duration value for the return window, expressed in the specified unit.
seller_identifier
string
Identifier for the seller of the bundle.
images
array of string
An array of image URLs associated with the bundle.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
seller_identifier
string
Nullable
delivery_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
article
object (OrderBagArticle)
Show
identifiers
object
Nullable
Details of Identifiers associated with the article.
return_config
object (ReturnConfig)
Show
returnable
boolean
Nullable
Indicates whether the article is eligible for return, allowing customers to send it back under specified conditions.
time
number
Nullable
The time frame within which the return must be initiated, typically measured in days.
unit
string
Nullable
The unit of time for the return period (e.g., days, weeks).
uid
string
Nullable
A unique identifier for the article within the order bag.
size
string
Nullable
The size of the article, which may be relevant for clothing.
tags
array of string
Nullable
An array of tags associated with the article.
_custom_json
object
Nullable
A custom JSON object containing additional details or configurations specific to the article.
brand
object (OrderBrandName)
Show
logo
string
Nullable
A URL or path to the logo image associated with the brand.
company
integer
Nullable
A unique identifier for the company associated with the brand.
id
integer
A unique identifier for the brand within the system.
created_on
string
| date-time
Nullable
Timestamp when the brand of the order was created.
brand_name
string
Nullable
The name of the brand associated with the order.
modified_on
string
| date-time
Nullable
Timestamp when the brand of the order was modified.
group_id
string
Nullable
affiliate_bag_details
object (AffiliateBagsDetails)
Show
affiliate_bag_id
string
Nullable
A unique identifier for the affiliate bag.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
item
object (PlatformItem)
Show
id
integer
Nullable
Unique identifier for the platform item.
attributes
object (PlatformArticleAttributes)
Show
currency
string
Nullable
The currency in which the price of the article is specified.
brand_id
integer
Nullable
Identifier for the brand associated with the item.
slug_key
string
Nullable
A user-friendly string that represents the item, often used in URLs.
l3_category
integer
Nullable
Represents the product's classification at the third level in the e-commerce platform's category hierarchy, using an integer identifier.
l3_category_name
string
Nullable
Name of the third-level category under which the product is listed.
last_updated_at
string
| date-time
Nullable
Timestamp when any aspect of the associated record was modified, formatted as date-time.
name
string
Nullable
The name of the product item.
l2_category
array of string
Nullable
Represents the second level of categorization for items, helping customers narrow down their search.
brand
string
Nullable
Name of the brand associated with the item.
image
array of string
Nullable
Array of image URLs representing the item.
code
string
Nullable
Unique code for the item, often used for inventory management.
l1_category
array of string
Nullable
Represents the highest or top-tier level of categorization for the product.
size
string
Nullable
Size specification of the product, if applicable.
can_cancel
boolean
Nullable
Indicates whether the item can be canceled after order placement.
can_return
boolean
Nullable
Indicates whether the item is eligible for return.
branch_url
string
Nullable
URL linking to a specific branch or store where the item is available.
meta
object
Nullable
Meta data containing additional, dynamic information about the item.
color
string
Nullable
Color specification of the product, if applicable.
department_id
integer
Nullable
Identifier for the department associated with the product.
images
array of string
Nullable
Array of image URLs representing different views or angles of the item.
tags
array of string
Nullable
Custom labels or keywords associated with the item for categorization, filtering, or business logic purposes.
payment_methods
array of object (BagPaymentMethods)
An array detailing the various payment methods utilized for the transaction. Each item within this array represents a distinct method of payment. It encapsulates the details of various payment methods available for completing a transaction. It includes comprehensive information such as the payment mode, amount, transaction status, and identifiers for each payment method.
Show
mode
string
Nullable
The payment mode used for the transaction.
amount
number
Nullable
The total amount associated with the payment method
payment_info
array of object (BagPaymentMethods)
Show
mode
string
Nullable
The payment mode used for the transaction.
amount
number
Nullable
The total amount associated with the payment method
quantity
integer
Nullable
The number of items contained in the bag.
identifier
string
Nullable
A unique identifier for the bag.
can_return
boolean
Nullable
Indicates whether the items in the bag are eligible for return by the customer.
can_cancel
boolean
Nullable
Indicates whether the bag is eligible for cancellation by the customer.
display_name
string
Nullable
A user-friendly name for the bag.
line_number
integer
Nullable
A unique identifier for each line item in a bag.
meta
object
Meta data of the bags contains additional, potentially dynamic information about the bags.
applied_promos
array of object (AppliedPromos)
Show
promotion_type
string
Nullable
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
promotion_name
string
Nullable
The name of the promotional campaign or offer.
discount_rules
array of object (DiscountRules)
A list of rules that define the conditions under which discounts are applied.
Show
value
integer
Nullable
type
string
Nullable
amount
number
Nullable
The total monetary value of the discount or promotion.
article_quantity
integer
Nullable
The quantity of articles required to qualify for the promotion.
buy_rules
array of object (BuyRules)
A list of rules that outline the conditions for purchasing items under the promotion.
Show
Rules of promotion which suffies then only the promotion is applied.
item_criteria
object (ItemCriterias)
Show
item_brand
array of integer
Nullable
cart_conditions
object
Nullable
Specifies the rules that must be met at the cart level for any purchasing rules or promotional discounts to be applied. Specifically, it includes criteria such as the total quantity of items in the cart. For instance, a rule might require that the cart contains at least one item for the promotion to apply. This setup allows for the dynamic application of discounts or special buying rules based on cart conditions.
promo_id
string
Nullable
A unique identifier for the promotion.
mrp_promotion
boolean
Nullable
A flag that designates whether or not the promotion is an MRP (manufacturer's reduced price) promotion.
applied_free_articles
array of object (AppliedFreeArticles)
A list of articles that are eligible for free under the promotion.
Show
article_id
string
A unique identifier for the article to which the free gift is applied.
free_gift_item_details
object (FreeGiftItems)
Details of the free gift item associated with the article, including relevant attributes like name, description, and any other specifications.
Show
item_slug
string
A unique identifier for the item, typically used in URLs for SEO purposes.
item_name
string
The name of the item.
item_price_details
object (ItemPriceDetails)
Show
marked
object (PriceMinMax)
Show
min
number
| float
The minimum price value. Represents the lowest price in the price range.
max
number
| float
The maximum price value. Represents the highest price in the price range.
effective
object (PriceMinMax)
Show
min
number
| float
The minimum price value. Represents the lowest price in the price range.
max
number
| float
The maximum price value. Represents the highest price in the price range.
currency
string
The currency in which the prices details associated with the item is specified.
item_brand_name
string
The brand name of the item.
item_id
integer
| int32
A unique numerical identifier for the item.
item_images_url
array of string
A list of URLs pointing to images of the item.
parent_item_identifier
string
An identifier for the parent item with which the free gift is associated, typically used to link the free gift to the original purchased item.
quantity
number
The quantity of the free gift items applied to the article.
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
current_status
object (CurrentStatus)
Show
store_id
integer
Nullable
A unique identifier for the store associated with the shipment.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number for the delivery.
kafka_sync
boolean
Nullable
A flag indicating whether the current status is synchronized with Kafka or not.
delivery_partner_id
integer
Nullable
A unique identifier for the delivery partner responsible for handling the shipment.
state_type
string
Nullable
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey, including route optimization and carrier selection.
Enum
state_id
integer
Nullable
A unique identifier for the specific state of the shipment.
id
integer
A unique identifier for the current status entry
created_at
string
| date-time
Nullable
Denotes the date and time when the bag status was created.
created_ts
string
| date-time
Nullable
A timestamp indicating when the status was created
shipment_id
string
Nullable
A unique identifier for the shipment.
updated_at
string
| date-time
Nullable
The date and time when the current status was last updated.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
A unique identifier for the bag associated with the shipment.
status
string
Nullable
A descriptive label representing the current status of the shipment.
bag_id
integer
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
is_parent
boolean
Nullable
A flag indicating whether the current bag is a parent entity or not.
dp_assignment
boolean
Nullable
Indicates whether a delivery partner has been assigned to the shipment.
total_items
integer
Nullable
The total number of items contained within the shipment,
fulfilling_store
object (FulfillingStore)
Show
phone
string
The contact phone number for the fulfilling store.
pincode
string
The postal code for the fulfilling store's location.
meta
object
Meta data of the fulfilling store contains additional, potentially dynamic information about the fulfilling store.
address
string
The complete address of the fulfilling store.
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
Display friendly version of the Fulfilment Store Address.
id
integer
The unique id or identifier of a fulfilment store.
code
string
The unique code of the fulfilment store.
store_name
string
The unique name of a fulfillment store.
country
string
The name of the country associated with a specific fulfilment store.
fulfillment_channel
string
The channel through which fulfillment is managed.
contact_person
string
The name of the contact person associated with a fulfilling store.
state
string
The state or region where the fulfilling store is located.
city
string
The city in which the fulfilling store is situated.
store_email
string
Nullable
The email address of the fulfilling store.
meta
object
Meta data of the shipment contains additional, potentially dynamic information about the shipment.
pdf_links
object
PDF Links associated with the shipment.
payment_mode
string
Nullable
The mode of payment used for the shipment.
packaging_type
string
Nullable
Defines the type of packaging used for the product, encompassing materials, design, and form factors.
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
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
An array of charges applied to the shipment.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
vertical
string
Nullable
The business vertical or category to which the shipment belongs.
shipment_id
string
A unique identifier for the shipment.
payments
object (ShipmentPayments)
Show
mode
string
Nullable
The payment mode used for the shipment.
logo
string
Nullable
A URL or path to the logo associated with the payment method.
source
string
Nullable
The source or origin of the payment
operational_status
string
Nullable
The operational status of the shipment.
status
object (ShipmentStatusData)
Show
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
bag_list
array of string
Nullable
The list of bags that are in this shipment status transition.
id
integer
Nullable
Unique identifier for a shipment status.
created_at
string
| date-time
Nullable
Denotes the date and time when the transition was created.
created_ts
string
Nullable
A timestamp indicating when the status entry was created.
shipment_id
string
Nullable
The unique identifier for the shipment.
status
string
Nullable
The current status of the shipment.
display_name
string
Nullable
A user-friendly name or description of the current shipment status.
current_shipment_status
string
Nullable
Reflects the most recent status of the shipment.
status_created_at
string
| date-time
Nullable
Denotes the date and time when the transition of the status of the shipment was created.
total_bags
integer
Nullable
The total number of bags in the shipment.
shipment_created_at
string
| date-time
Nullable
Denotes the date and time when the shipment was created.
shipment_created_ts
string
Nullable
A timestamp representing when the shipment was created.
currency
object (Currency)
Show
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.
currency_symbol
string
The symbol representing the currency.
currency_info
object (CurrencyInfo)
Show
ordering_currency
object (OrderingCurrency)
Show
currency_code
string
This specifies the currency code for all amounts.
currency_name
string
The full name of the currency.
currency_symbol
string
The symbol representing the currency.
currency_sub_unit
string
The sub-unit of the currency
conversion_rate
object (ConversionRate)
Show
base
string
The base currency code, example 'INR' for Indian Rupee, against which all conversion rates are calculated. Follows the ISO 4217 standard.This includes the currency's name, its conversion rate relative to the base currency ('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency conversion but also enriches the data with useful currency descriptors, enhancing financial operations and analyses.
rates
object
An object , where each key is a currency code and its value is an object containing detailed information
about that currency. This includes the currency's name, its conversion rate relative to the base currency
('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency
conversion but also enriches the data with useful currency descriptors.
previous_shipment_id
string
Nullable
The ID of the previous shipment in the sequence.
shipment_update_time
number
Nullable
A numerical representation of the last update time for the shipment
rto_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
credit_note_id
string
Nullable
The identifier for any credit note issued for the shipment
is_self_ship
boolean
Nullable
A flag indicating whether the shipment is being self-shipped by the seller or vendor.
mode_of_payment
string
Nullable
The specific mode of payment used for the transaction
is_lapa_enabled
boolean
Flag to show NDR actions based on LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true, else false.
forward_end_shipment_id
string
Nullable
The forward_end_shipment_id represents the shipment ID of the original forward journey shipment. When a shipment is transitioned to a return journey, the original shipment ID from the forward journey is recorded in the forward_end_shipment_id field of the return journey shipment. Even if the return shipment is later split into multiple shipments, each of these shipments will retain the same forward_end_shipment_id value that was assigned during the initial return journey initiation. This ensures that all return shipments can be traced back to the original forward journey shipment.
logistics_meta
object
An object storing detailed logistics-related information, including courier partner details and other relevant metadata.
packages
array of object (PackageSchema)
Array of packages to be created or updated for the shipment. At least two packages are required for MPS functionality.
Show
id
string
Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.
packaging_id
string
Nullable
Optional reference to a predefined packaging configuration or template used for creating physical packages.
name
string
Nullable
A human-readable name or label for the package, used for identification and organizational purposes.
size
string
Nullable
The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.
package_type
string
Nullable
The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).
length
number
| float
Nullable
The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
width
number
| float
Nullable
The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
height
number
| float
Nullable
The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
weight
number
| float
Nullable
The actual weight of the package in kilograms, including packaging materials and products.
error_rate
number
| float
Nullable
The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).
package_vol_weight
number
| float
Nullable
The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.
max_weight
number
| float
Nullable
The maximum weight capacity that this package can handle, used for validation and logistics planning.
awb
string
Nullable
Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.
pdf_links
object
Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.
Default Value : [object Object]
products
array of object (PackageProduct)
List of products contained within this package. Each product specifies its line number, quantity, and identifier.
Show
line_number
integer
The line number of the product within the shipment, used for tracking and identification purposes.
quantity
number
The quantity of the product included in this package.
identifier
string
The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.
order_id
string
Nullable
A unique identifier associated with the order.
channel
object (PlatformChannel)
Show
logo
string
Nullable
Represents the logo of the channel through which the order was placed.
name
string
Nullable
Represents the name of the channel through which the order was placed
user_info
object (UserDataInfo)
Show
Contains the details of the user who created the order including identifying information and relevant metadata.
id
integer
Nullable
The unique identifier associated with the user.
user_oid
string
Nullable
The object ID for the user, used for referencing the user in various operations.
mongo_user_id
string
Nullable
The identifier for the user.
external_customer_id
string
Nullable
The identifier for the user in external systems.
first_name
string
Nullable
The first name of the user.
last_name
string
Nullable
The last name of the user.
mobile
string
Nullable
The mobile phone number of the user.
email
string
Nullable
The email address of the user.
meta
object
Nullable
Additional metadata related to the user.
is_anonymous_user
boolean
Nullable
Indicates whether the user is an anonymous user (true) or registered (false).
name
string
Nullable
A full name of the user, which may be a combination of first and last name.
gender
string
Nullable
The gender of the user.
country_phone_code
string
The country-specific phone code, useful for formatting mobile numbers correctly.
order_value
number
Nullable
currency
object (Currency)
Show
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.
currency_symbol
string
The symbol representing the currency.
currency_info
object (CurrencyInfo)
Show
ordering_currency
object (OrderingCurrency)
Show
currency_code
string
This specifies the currency code for all amounts.
currency_name
string
The full name of the currency.
currency_symbol
string
The symbol representing the currency.
currency_sub_unit
string
The sub-unit of the currency
conversion_rate
object (ConversionRate)
Show
base
string
The base currency code, example 'INR' for Indian Rupee, against which all conversion rates are calculated. Follows the ISO 4217 standard.This includes the currency's name, its conversion rate relative to the base currency ('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency conversion but also enriches the data with useful currency descriptors, enhancing financial operations and analyses.
rates
object
An object , where each key is a currency code and its value is an object containing detailed information
about that currency. This includes the currency's name, its conversion rate relative to the base currency
('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency
conversion but also enriches the data with useful currency descriptors.
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
loyalty_discount_details
object (LoyaltyDiscountDetails)
Show
Object containing detailed information about the loyalty discount applied during an order.
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed.
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace.
Enum
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order.
lane
string
Nullable
The lane associated with the order.
page
object (Page)
Show
An object representing a page with pagination details.
item_total
integer
| int32
The total number of all items across all pages.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, can be 'cursor' or 'number'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Response
List orders
getOrders
The State Manager is responsible for handling state logic for entities such as Shipment and Bag. It determines the behavior of the Shipment, including whether shipment breaking should be allowed, and what tasks should be run during particular state transitions, such as generating an invoice ID. Additionally, it controls which states are permissible after certain states. The State Manager is enabled at the application level and if not set it has default behavior, which determines the default flow of a shipment if no custom behavior is set.
Operations
POST
# Allows esm config updation
GET
# Retrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
bodyrequestBody
object (TransitionConfigPayload)
Required
Hide
data
object (TransitionConfigData)
Show
conditions
object (TransitionConfigCondition)
Conditions that must be met for the ESM config to be applied.
Show
app_id
string
Required
The unique identifier of the application to which the configuration applies.
ordering_channel
string
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
entity
string
Required
The type of entity that the configuration pertains to.
configs
array of object (Config)
The configuration settings for the entity transition. This includes pre_hooks, post_hooks, and flags for each transition state.
Show
from_state
string
Source state from which state transition will take place
to_state
string
Target state to which state transition will take place
pre_hooks
array of object (PreHook)
Tasks to be run before state transition
Show
Defines pre-hooks that execute specific tasks before a main operation. Each hook is identified by a task name
and can accept additional keyword arguments (`kwargs`) to customize its behavior.
Available PreHooks:
| PreHook | Description | kwargs |
|---|---|---|
| populate_b2b_details | Populates B2B buyer GSTIN details into the shipment. | None required |
| lock_entity | Locks the parent entity based on configured settings or transition properties. | None required |
| update_sla_time | Updates the estimated Service Level Agreement time of the shipment. |
|
| resume_tasks_after_unlock | Resumes tasks associated with the parent entity after unlocking it. | None required |
| process_gst_calculation | Initiates the GST calculation process for shipments and updates HSN-related data on bag level. | None required |
| populate_filters_for_manifest | Generates a manifest filter entry for the shipment. | None required |
| deactivate_manifest_filter_entry | Deactivates a manifest filter entry associated with a shipment. | None required |
| state_hopper | Hops the shipment's state to the requested state. |
|
| calculate_bag_gst_tag | Calculates and sets GST tags for bags based on customer and seller states. | None required. |
| set_high_priority_to_hyperlocal_dp_shipments | Temporarily sets the delivery priority for hyperlocal delivery partners. | None required |
| update_is_customer_return_allowed_flag | Updates the flag to indicate whether customer returns are allowed. |
|
| generate_ticket | Generates a support ticket for the shipment. | None required |
| update_shipment_manifest_mapping | Updates the mapping of shipment to its manifest. | None required |
| inject_missing_state | Injects a missing state into the state transition process. |
|
| check_and_restore_promo | Checks for and restores any applicable promotional offers for the shipment. | None required |
| reassign_dp | Reassigns the shipment to a different delivery partner. | None required |
| update_article_and_store_data | Updates article and store configuration data when the store is reassigned. | None required |
| inventory_movement | Manages inventory depletion, handling movements from one state to another. |
|
| check_and_init_refund | Checks the status of a refund request and initializes the refund process. |
|
| assign_shipment_to_dp | Assigns the shipment to a courier partner. | None required |
| fetch_new_courier_partner_data | Fetches courier partner data from Stormbreaker based on the journey type. | None required |
| configure_clear_cart | Clears the customer's cart when enabled. | None required |
| configure_coupon | Restores coupons once all bags are cancelled. | None required |
task
string
Required
Name of the hook that has to be added
kwargs
object
Additional parameters for the hook
filter
object (Filter)
Criteria to filter which hooks are applied based on certain conditions.
Show
Pass filters to set specific conditions
order_type
string
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
is_partial_transition
boolean
Specifies whether a partial transition of the order is allowed, allowing some components to progress while others remain in the current state.
auto_trigger_dp_assignment_acf
boolean
Indicates whether the assignment of a designated person is automatically triggered in the context of ACF.
lock_status
string
Indicates the current locking status of the shipment.
Enum
lock_after_transition
boolean
Specifies whether locking is required after transitioning to the next status.
lock_after_transition : true - Lock Transition enabled
lock_after_transition : false - Lock Transition set false
resume_tasks_after_unlock
boolean
Indicates whether tasks should resume automatically after unlocking, such as DP assignment task and invoicing task.
is_invoice_id_present
boolean
Indicates whether an invoice ID is present for the order.
is_credit_note_generated
boolean
Indicates whether a credit note has been generated for the order.
fulfill_virtual_invoice
boolean
Specifies whether an automated virtual invoice ID is associated with the order.
next_status
string
Indicates the next status to which the order will transition.
Enum
is_hook_enabled
boolean
Indicates whether a task is enabled for the order.
pos_credit_note_check
boolean
Specifies whether a credit note check is performed in a point of sale (POS) scenario.
order_platform
string
Specifies the platform on which the order was placed.
Enum
refund_type
string
Indicates the type of refund associated with the order.
Enum
is_non_pos_platform
boolean
Specifies whether the platform is non-point of sale (POS) in nature.
is_self_ship
boolean
Indicates whether the order is self-shipped by the seller.
seller_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `seller_country_code`: US
- `seller_country_code`: UK
- `seller_country_code`: IN
customer_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `customer_country_code`: US
- `customer_country_code`: UK
- `customer_country_code`: IN
is_test_order
boolean
Indicates whether the order is a test order used for testing purposes - `is_test_order` : True - indicates test order
task_trigger_condition
array of string
Specifies trigger conditions:
- `status_update`: Status Update
- `data_update`: Data Update
Enum
fulfillment_option_slug
string
Represents the unique slug associated with the fulfillment option attached to the shipment.
This slug helps determine the fulfillment method and operational flow used to deliver the shipment.
Examples:
- "standard-delivery"
- "hyperlocal-delivery"
post_hooks
array of object (PostHook)
Tasks to be run after state transition
Show
Defines post-hooks that execute specific tasks before a main operation. Each hook is identified by a task name
and can accept additional keyword arguments (`kwargs`) to customize its behavior.
Available PreHooks:
| PreHook | Description | kwargs |
|---|---|---|
| populate_b2b_details | Populates B2B buyer GSTIN details into the shipment. | None required |
| lock_entity | Locks the parent entity based on configured settings or transition properties. | None required |
| update_sla_time | Updates the estimated Service Level Agreement time of the shipment. |
|
| resume_tasks_after_unlock | Resumes tasks associated with the parent entity after unlocking it. | None required |
| process_gst_calculation | Initiates the GST calculation process for shipments and updates HSN-related data on bag level. | None required |
| populate_filters_for_manifest | Generates a manifest filter entry for the shipment. | None required |
| deactivate_manifest_filter_entry | Deactivates a manifest filter entry associated with a shipment. | None required |
| state_hopper | Hops the shipment's state to the requested state. |
|
| calculate_bag_gst_tag | Calculates and sets GST tags for bags based on customer and seller states. | None required. |
| set_high_priority_to_hyperlocal_dp_shipments | Temporarily sets the delivery priority for hyperlocal delivery partners. | None required |
| update_is_customer_return_allowed_flag | Updates the flag to indicate whether customer returns are allowed. |
|
| generate_ticket | Generates a support ticket for the shipment. | None required |
| update_shipment_manifest_mapping | Updates the mapping of shipment to its manifest. | None required |
| inject_missing_state | Injects a missing state into the state transition process. |
|
| check_and_restore_promo | Checks for and restores any applicable promotional offers for the shipment. | None required |
| reassign_dp | Reassigns the shipment to a different delivery partner. | None required |
| update_article_and_store_data | Updates article and store configuration data when the store is reassigned. | None required |
| inventory_movement | Manages inventory depletion, handling movements from one state to another. |
|
| check_and_init_refund | Checks the status of a refund request and initializes the refund process. |
|
| assign_shipment_to_dp | Assigns the shipment to a courier partner. | None required |
| fetch_new_courier_partner_data | Fetches courier partner data from Stormbreaker based on the journey type. | None required |
| configure_clear_cart | Clears the customer's cart when enabled. | None required |
| configure_coupon | Restores coupons once all bags are cancelled. | None required |
task
string
Required
Name of the hook that has to be added
kwargs
object
Additional parameters for the hook
filter
object (Filter)
Criteria to filter which hooks are applied based on certain conditions.
Show
Pass filters to set specific conditions
order_type
string
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
is_partial_transition
boolean
Specifies whether a partial transition of the order is allowed, allowing some components to progress while others remain in the current state.
auto_trigger_dp_assignment_acf
boolean
Indicates whether the assignment of a designated person is automatically triggered in the context of ACF.
lock_status
string
Indicates the current locking status of the shipment.
Enum
lock_after_transition
boolean
Specifies whether locking is required after transitioning to the next status.
lock_after_transition : true - Lock Transition enabled
lock_after_transition : false - Lock Transition set false
resume_tasks_after_unlock
boolean
Indicates whether tasks should resume automatically after unlocking, such as DP assignment task and invoicing task.
is_invoice_id_present
boolean
Indicates whether an invoice ID is present for the order.
is_credit_note_generated
boolean
Indicates whether a credit note has been generated for the order.
fulfill_virtual_invoice
boolean
Specifies whether an automated virtual invoice ID is associated with the order.
next_status
string
Indicates the next status to which the order will transition.
Enum
is_hook_enabled
boolean
Indicates whether a task is enabled for the order.
pos_credit_note_check
boolean
Specifies whether a credit note check is performed in a point of sale (POS) scenario.
order_platform
string
Specifies the platform on which the order was placed.
Enum
refund_type
string
Indicates the type of refund associated with the order.
Enum
is_non_pos_platform
boolean
Specifies whether the platform is non-point of sale (POS) in nature.
is_self_ship
boolean
Indicates whether the order is self-shipped by the seller.
seller_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `seller_country_code`: US
- `seller_country_code`: UK
- `seller_country_code`: IN
customer_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `customer_country_code`: US
- `customer_country_code`: UK
- `customer_country_code`: IN
is_test_order
boolean
Indicates whether the order is a test order used for testing purposes - `is_test_order` : True - indicates test order
task_trigger_condition
array of string
Specifies trigger conditions:
- `status_update`: Status Update
- `data_update`: Data Update
Enum
fulfillment_option_slug
string
Represents the unique slug associated with the fulfillment option attached to the shipment.
This slug helps determine the fulfillment method and operational flow used to deliver the shipment.
Examples:
- "standard-delivery"
- "hyperlocal-delivery"
flags
object (Flags)
Various flags related to the transition. These include options and settings that influence the behavior of the state transition, such as whether partial transitions are allowed or whether the transition can break the entity.
Show
allow_partial_transition
array of object (FlagData)
Indicates whether a partial transition of bags to the next state is permissible,
allowing some bags to progress while others remain in the current state.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
can_break_entity
array of object (FlagData)
Specifies whether bags within a shipment, set,cdf or entity can be broken individually or as a group.
If set to false, all bags within the entity must remain together and transition together to the same state.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_bag_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at the bag level.
Allowed fields are:
- meta
- pdf_links
- affiliate_meta
- delivery_awb_number
- store_invoice_id
- store_id
- return_store_id
- eway_bill_id
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_bag_status_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at the bag status level.
Allowed fields are:
- json
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_entity_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at shipment level.
Allowed fields are:
- meta
- pdf_links
- affiliate_meta
- delivery_awb_number
- store_invoice_id
- store_id
- return_store_id
- eway_bill_id
- logistics_meta
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_entity_status_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at the Entity status level.
Allowed fields are:
- json
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
status_update_type
array of object (FlagData)
Describes the type of journey associated with the particular status of the shipment.
Possible values are:
- positive
- negative
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_bag_status_reason_allowed
array of object (FlagData)
Indicates whether a reason at the product level should be allowed for a particular status.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_entity_status_reason_allowed
array of object (FlagData)
Indicates whether a reason at the shipment level should be allowed for a particular status.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
transition_strategy
array of object (FlagData)
This flag is used to define the shipment breaking strategy.
Possible values are:
- break_shipment_based_on_location_reassignment
- break_shipment_based_on_groups
- break_shipment_based_on_stormbreaker
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Request body
data
object (TransitionConfigData)
Show
conditions
object (TransitionConfigCondition)
Conditions that must be met for the ESM config to be applied.
Show
app_id
string
Required
The unique identifier of the application to which the configuration applies.
ordering_channel
string
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
entity
string
Required
The type of entity that the configuration pertains to.
configs
array of object (Config)
The configuration settings for the entity transition. This includes pre_hooks, post_hooks, and flags for each transition state.
Show
from_state
string
Source state from which state transition will take place
to_state
string
Target state to which state transition will take place
pre_hooks
array of object (PreHook)
Tasks to be run before state transition
Show
Defines pre-hooks that execute specific tasks before a main operation. Each hook is identified by a task name
and can accept additional keyword arguments (`kwargs`) to customize its behavior.
Available PreHooks:
| PreHook | Description | kwargs |
|---|---|---|
| populate_b2b_details | Populates B2B buyer GSTIN details into the shipment. | None required |
| lock_entity | Locks the parent entity based on configured settings or transition properties. | None required |
| update_sla_time | Updates the estimated Service Level Agreement time of the shipment. |
|
| resume_tasks_after_unlock | Resumes tasks associated with the parent entity after unlocking it. | None required |
| process_gst_calculation | Initiates the GST calculation process for shipments and updates HSN-related data on bag level. | None required |
| populate_filters_for_manifest | Generates a manifest filter entry for the shipment. | None required |
| deactivate_manifest_filter_entry | Deactivates a manifest filter entry associated with a shipment. | None required |
| state_hopper | Hops the shipment's state to the requested state. |
|
| calculate_bag_gst_tag | Calculates and sets GST tags for bags based on customer and seller states. | None required. |
| set_high_priority_to_hyperlocal_dp_shipments | Temporarily sets the delivery priority for hyperlocal delivery partners. | None required |
| update_is_customer_return_allowed_flag | Updates the flag to indicate whether customer returns are allowed. |
|
| generate_ticket | Generates a support ticket for the shipment. | None required |
| update_shipment_manifest_mapping | Updates the mapping of shipment to its manifest. | None required |
| inject_missing_state | Injects a missing state into the state transition process. |
|
| check_and_restore_promo | Checks for and restores any applicable promotional offers for the shipment. | None required |
| reassign_dp | Reassigns the shipment to a different delivery partner. | None required |
| update_article_and_store_data | Updates article and store configuration data when the store is reassigned. | None required |
| inventory_movement | Manages inventory depletion, handling movements from one state to another. |
|
| check_and_init_refund | Checks the status of a refund request and initializes the refund process. |
|
| assign_shipment_to_dp | Assigns the shipment to a courier partner. | None required |
| fetch_new_courier_partner_data | Fetches courier partner data from Stormbreaker based on the journey type. | None required |
| configure_clear_cart | Clears the customer's cart when enabled. | None required |
| configure_coupon | Restores coupons once all bags are cancelled. | None required |
task
string
Required
Name of the hook that has to be added
kwargs
object
Additional parameters for the hook
filter
object (Filter)
Criteria to filter which hooks are applied based on certain conditions.
Show
Pass filters to set specific conditions
order_type
string
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
is_partial_transition
boolean
Specifies whether a partial transition of the order is allowed, allowing some components to progress while others remain in the current state.
auto_trigger_dp_assignment_acf
boolean
Indicates whether the assignment of a designated person is automatically triggered in the context of ACF.
lock_status
string
Indicates the current locking status of the shipment.
Enum
lock_after_transition
boolean
Specifies whether locking is required after transitioning to the next status.
lock_after_transition : true - Lock Transition enabled
lock_after_transition : false - Lock Transition set false
resume_tasks_after_unlock
boolean
Indicates whether tasks should resume automatically after unlocking, such as DP assignment task and invoicing task.
is_invoice_id_present
boolean
Indicates whether an invoice ID is present for the order.
is_credit_note_generated
boolean
Indicates whether a credit note has been generated for the order.
fulfill_virtual_invoice
boolean
Specifies whether an automated virtual invoice ID is associated with the order.
next_status
string
Indicates the next status to which the order will transition.
Enum
is_hook_enabled
boolean
Indicates whether a task is enabled for the order.
pos_credit_note_check
boolean
Specifies whether a credit note check is performed in a point of sale (POS) scenario.
order_platform
string
Specifies the platform on which the order was placed.
Enum
refund_type
string
Indicates the type of refund associated with the order.
Enum
is_non_pos_platform
boolean
Specifies whether the platform is non-point of sale (POS) in nature.
is_self_ship
boolean
Indicates whether the order is self-shipped by the seller.
seller_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `seller_country_code`: US
- `seller_country_code`: UK
- `seller_country_code`: IN
customer_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `customer_country_code`: US
- `customer_country_code`: UK
- `customer_country_code`: IN
is_test_order
boolean
Indicates whether the order is a test order used for testing purposes - `is_test_order` : True - indicates test order
task_trigger_condition
array of string
Specifies trigger conditions:
- `status_update`: Status Update
- `data_update`: Data Update
Enum
fulfillment_option_slug
string
Represents the unique slug associated with the fulfillment option attached to the shipment.
This slug helps determine the fulfillment method and operational flow used to deliver the shipment.
Examples:
- "standard-delivery"
- "hyperlocal-delivery"
post_hooks
array of object (PostHook)
Tasks to be run after state transition
Show
Defines post-hooks that execute specific tasks before a main operation. Each hook is identified by a task name
and can accept additional keyword arguments (`kwargs`) to customize its behavior.
Available PreHooks:
| PreHook | Description | kwargs |
|---|---|---|
| populate_b2b_details | Populates B2B buyer GSTIN details into the shipment. | None required |
| lock_entity | Locks the parent entity based on configured settings or transition properties. | None required |
| update_sla_time | Updates the estimated Service Level Agreement time of the shipment. |
|
| resume_tasks_after_unlock | Resumes tasks associated with the parent entity after unlocking it. | None required |
| process_gst_calculation | Initiates the GST calculation process for shipments and updates HSN-related data on bag level. | None required |
| populate_filters_for_manifest | Generates a manifest filter entry for the shipment. | None required |
| deactivate_manifest_filter_entry | Deactivates a manifest filter entry associated with a shipment. | None required |
| state_hopper | Hops the shipment's state to the requested state. |
|
| calculate_bag_gst_tag | Calculates and sets GST tags for bags based on customer and seller states. | None required. |
| set_high_priority_to_hyperlocal_dp_shipments | Temporarily sets the delivery priority for hyperlocal delivery partners. | None required |
| update_is_customer_return_allowed_flag | Updates the flag to indicate whether customer returns are allowed. |
|
| generate_ticket | Generates a support ticket for the shipment. | None required |
| update_shipment_manifest_mapping | Updates the mapping of shipment to its manifest. | None required |
| inject_missing_state | Injects a missing state into the state transition process. |
|
| check_and_restore_promo | Checks for and restores any applicable promotional offers for the shipment. | None required |
| reassign_dp | Reassigns the shipment to a different delivery partner. | None required |
| update_article_and_store_data | Updates article and store configuration data when the store is reassigned. | None required |
| inventory_movement | Manages inventory depletion, handling movements from one state to another. |
|
| check_and_init_refund | Checks the status of a refund request and initializes the refund process. |
|
| assign_shipment_to_dp | Assigns the shipment to a courier partner. | None required |
| fetch_new_courier_partner_data | Fetches courier partner data from Stormbreaker based on the journey type. | None required |
| configure_clear_cart | Clears the customer's cart when enabled. | None required |
| configure_coupon | Restores coupons once all bags are cancelled. | None required |
task
string
Required
Name of the hook that has to be added
kwargs
object
Additional parameters for the hook
filter
object (Filter)
Criteria to filter which hooks are applied based on certain conditions.
Show
Pass filters to set specific conditions
order_type
string
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
is_partial_transition
boolean
Specifies whether a partial transition of the order is allowed, allowing some components to progress while others remain in the current state.
auto_trigger_dp_assignment_acf
boolean
Indicates whether the assignment of a designated person is automatically triggered in the context of ACF.
lock_status
string
Indicates the current locking status of the shipment.
Enum
lock_after_transition
boolean
Specifies whether locking is required after transitioning to the next status.
lock_after_transition : true - Lock Transition enabled
lock_after_transition : false - Lock Transition set false
resume_tasks_after_unlock
boolean
Indicates whether tasks should resume automatically after unlocking, such as DP assignment task and invoicing task.
is_invoice_id_present
boolean
Indicates whether an invoice ID is present for the order.
is_credit_note_generated
boolean
Indicates whether a credit note has been generated for the order.
fulfill_virtual_invoice
boolean
Specifies whether an automated virtual invoice ID is associated with the order.
next_status
string
Indicates the next status to which the order will transition.
Enum
is_hook_enabled
boolean
Indicates whether a task is enabled for the order.
pos_credit_note_check
boolean
Specifies whether a credit note check is performed in a point of sale (POS) scenario.
order_platform
string
Specifies the platform on which the order was placed.
Enum
refund_type
string
Indicates the type of refund associated with the order.
Enum
is_non_pos_platform
boolean
Specifies whether the platform is non-point of sale (POS) in nature.
is_self_ship
boolean
Indicates whether the order is self-shipped by the seller.
seller_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `seller_country_code`: US
- `seller_country_code`: UK
- `seller_country_code`: IN
customer_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `customer_country_code`: US
- `customer_country_code`: UK
- `customer_country_code`: IN
is_test_order
boolean
Indicates whether the order is a test order used for testing purposes - `is_test_order` : True - indicates test order
task_trigger_condition
array of string
Specifies trigger conditions:
- `status_update`: Status Update
- `data_update`: Data Update
Enum
fulfillment_option_slug
string
Represents the unique slug associated with the fulfillment option attached to the shipment.
This slug helps determine the fulfillment method and operational flow used to deliver the shipment.
Examples:
- "standard-delivery"
- "hyperlocal-delivery"
flags
object (Flags)
Various flags related to the transition. These include options and settings that influence the behavior of the state transition, such as whether partial transitions are allowed or whether the transition can break the entity.
Show
allow_partial_transition
array of object (FlagData)
Indicates whether a partial transition of bags to the next state is permissible,
allowing some bags to progress while others remain in the current state.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
can_break_entity
array of object (FlagData)
Specifies whether bags within a shipment, set,cdf or entity can be broken individually or as a group.
If set to false, all bags within the entity must remain together and transition together to the same state.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_bag_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at the bag level.
Allowed fields are:
- meta
- pdf_links
- affiliate_meta
- delivery_awb_number
- store_invoice_id
- store_id
- return_store_id
- eway_bill_id
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_bag_status_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at the bag status level.
Allowed fields are:
- json
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_entity_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at shipment level.
Allowed fields are:
- meta
- pdf_links
- affiliate_meta
- delivery_awb_number
- store_invoice_id
- store_id
- return_store_id
- eway_bill_id
- logistics_meta
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_entity_status_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at the Entity status level.
Allowed fields are:
- json
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
status_update_type
array of object (FlagData)
Describes the type of journey associated with the particular status of the shipment.
Possible values are:
- positive
- negative
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_bag_status_reason_allowed
array of object (FlagData)
Indicates whether a reason at the product level should be allowed for a particular status.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_entity_status_reason_allowed
array of object (FlagData)
Indicates whether a reason at the shipment level should be allowed for a particular status.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
transition_strategy
array of object (FlagData)
This flag is used to define the shipment breaking strategy.
Possible values are:
- break_shipment_based_on_location_reassignment
- break_shipment_based_on_groups
- break_shipment_based_on_stormbreaker
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
POST
Response
200
Config updated successfully
Hide
data
array of object (ConfigData)
The result of the config update operation, including whether it was acknowledged, upserted, or inserted.
Show
acknowledged
boolean
Indicates whether the update operation was acknowledged by the database.
is_upserted
boolean
Indicates whether the update operation resulted in an upsert (an update or insert).
is_inserted
boolean
Indicates whether the update operation resulted in a new document being inserted.
success
boolean
Indicates whether the config update operation was successful.
Examples
Parameters
Parameters are not required.
Response
Allows esm config updation
addStateManagerConfig
GET
Retrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
This endpoint retrieves the ESM (Entity State Manager) configuration for a specific application within a company. The retrieval is based on parameters such as application ID, ordering channel, and entity type.
The ESM config stores order processing configuration. Each document in the ESM config collection of Order Management System - OMS's database is a JSON object representing the configuration of a specific application ID. This includes filters, hooks, flags set on different state-transitions. This configuration is picked and accordingly features are enabled.
Parameters
company_idpath
integer
Required
The unique identifier of the company on the platform.
app_idquery
string
The unique identifier of the application.
ordering_channelquery
string
The channel through which orders are placed.
ordering_sourcequery
string
To uniquely identify the source through which order has been placed.
entityquery
string
The entity for which the configuration is applied.
GET
Response
200
This denotes a successful response. ESM config data fetched successfully for given application ID, ordering channel, and entity.
Hide
success
boolean
Indicates whether the request was successful.
data
array of object
An array of ESM configuration objects.
Show
conditions
object (TransitionConfigCondition)
Requested params that were passed in the API request. This includes application_id, ordering_channel and entity.
Show
app_id
string
The unique identifier of the application to which the configuration applies.
ordering_channel
string
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
entity
string
The type of entity that the configuration pertains to.
configs
array of object (Config)
The configuration settings for the entity transition. This includes pre_hooks, post_hooks, and flags for each state transition.
Show
from_state
string
Source state from which state transition will take place
to_state
string
Target state to which state transition will take place
pre_hooks
array of object (PreHook)
Tasks to be run before state transition
Show
Defines pre-hooks that execute specific tasks before a main operation. Each hook is identified by a task name
and can accept additional keyword arguments (`kwargs`) to customize its behavior.
Available PreHooks:
| PreHook | Description | kwargs |
|---|---|---|
| populate_b2b_details | Populates B2B buyer GSTIN details into the shipment. | None required |
| lock_entity | Locks the parent entity based on configured settings or transition properties. | None required |
| update_sla_time | Updates the estimated Service Level Agreement time of the shipment. |
|
| resume_tasks_after_unlock | Resumes tasks associated with the parent entity after unlocking it. | None required |
| process_gst_calculation | Initiates the GST calculation process for shipments and updates HSN-related data on bag level. | None required |
| populate_filters_for_manifest | Generates a manifest filter entry for the shipment. | None required |
| deactivate_manifest_filter_entry | Deactivates a manifest filter entry associated with a shipment. | None required |
| state_hopper | Hops the shipment's state to the requested state. |
|
| calculate_bag_gst_tag | Calculates and sets GST tags for bags based on customer and seller states. | None required. |
| set_high_priority_to_hyperlocal_dp_shipments | Temporarily sets the delivery priority for hyperlocal delivery partners. | None required |
| update_is_customer_return_allowed_flag | Updates the flag to indicate whether customer returns are allowed. |
|
| generate_ticket | Generates a support ticket for the shipment. | None required |
| update_shipment_manifest_mapping | Updates the mapping of shipment to its manifest. | None required |
| inject_missing_state | Injects a missing state into the state transition process. |
|
| check_and_restore_promo | Checks for and restores any applicable promotional offers for the shipment. | None required |
| reassign_dp | Reassigns the shipment to a different delivery partner. | None required |
| update_article_and_store_data | Updates article and store configuration data when the store is reassigned. | None required |
| inventory_movement | Manages inventory depletion, handling movements from one state to another. |
|
| check_and_init_refund | Checks the status of a refund request and initializes the refund process. |
|
| assign_shipment_to_dp | Assigns the shipment to a courier partner. | None required |
| fetch_new_courier_partner_data | Fetches courier partner data from Stormbreaker based on the journey type. | None required |
| configure_clear_cart | Clears the customer's cart when enabled. | None required |
| configure_coupon | Restores coupons once all bags are cancelled. | None required |
task
string
Name of the hook that has to be added
kwargs
object
Additional parameters for the hook
filter
object (Filter)
Criteria to filter which hooks are applied based on certain conditions.
Show
Pass filters to set specific conditions
order_type
string
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
is_partial_transition
boolean
Specifies whether a partial transition of the order is allowed, allowing some components to progress while others remain in the current state.
auto_trigger_dp_assignment_acf
boolean
Indicates whether the assignment of a designated person is automatically triggered in the context of ACF.
lock_status
string
Indicates the current locking status of the shipment.
Enum
lock_after_transition
boolean
Specifies whether locking is required after transitioning to the next status.
lock_after_transition : true - Lock Transition enabled
lock_after_transition : false - Lock Transition set false
resume_tasks_after_unlock
boolean
Indicates whether tasks should resume automatically after unlocking, such as DP assignment task and invoicing task.
is_invoice_id_present
boolean
Indicates whether an invoice ID is present for the order.
is_credit_note_generated
boolean
Indicates whether a credit note has been generated for the order.
fulfill_virtual_invoice
boolean
Specifies whether an automated virtual invoice ID is associated with the order.
next_status
string
Indicates the next status to which the order will transition.
Enum
is_hook_enabled
boolean
Indicates whether a task is enabled for the order.
pos_credit_note_check
boolean
Specifies whether a credit note check is performed in a point of sale (POS) scenario.
order_platform
string
Specifies the platform on which the order was placed.
Enum
refund_type
string
Indicates the type of refund associated with the order.
Enum
is_non_pos_platform
boolean
Specifies whether the platform is non-point of sale (POS) in nature.
is_self_ship
boolean
Indicates whether the order is self-shipped by the seller.
seller_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `seller_country_code`: US
- `seller_country_code`: UK
- `seller_country_code`: IN
customer_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `customer_country_code`: US
- `customer_country_code`: UK
- `customer_country_code`: IN
is_test_order
boolean
Indicates whether the order is a test order used for testing purposes - `is_test_order` : True - indicates test order
task_trigger_condition
array of string
Specifies trigger conditions:
- `status_update`: Status Update
- `data_update`: Data Update
Enum
fulfillment_option_slug
string
Represents the unique slug associated with the fulfillment option attached to the shipment.
This slug helps determine the fulfillment method and operational flow used to deliver the shipment.
Examples:
- "standard-delivery"
- "hyperlocal-delivery"
post_hooks
array of object (PostHook)
Tasks to be run after state transition
Show
Defines post-hooks that execute specific tasks before a main operation. Each hook is identified by a task name
and can accept additional keyword arguments (`kwargs`) to customize its behavior.
Available PreHooks:
| PreHook | Description | kwargs |
|---|---|---|
| populate_b2b_details | Populates B2B buyer GSTIN details into the shipment. | None required |
| lock_entity | Locks the parent entity based on configured settings or transition properties. | None required |
| update_sla_time | Updates the estimated Service Level Agreement time of the shipment. |
|
| resume_tasks_after_unlock | Resumes tasks associated with the parent entity after unlocking it. | None required |
| process_gst_calculation | Initiates the GST calculation process for shipments and updates HSN-related data on bag level. | None required |
| populate_filters_for_manifest | Generates a manifest filter entry for the shipment. | None required |
| deactivate_manifest_filter_entry | Deactivates a manifest filter entry associated with a shipment. | None required |
| state_hopper | Hops the shipment's state to the requested state. |
|
| calculate_bag_gst_tag | Calculates and sets GST tags for bags based on customer and seller states. | None required. |
| set_high_priority_to_hyperlocal_dp_shipments | Temporarily sets the delivery priority for hyperlocal delivery partners. | None required |
| update_is_customer_return_allowed_flag | Updates the flag to indicate whether customer returns are allowed. |
|
| generate_ticket | Generates a support ticket for the shipment. | None required |
| update_shipment_manifest_mapping | Updates the mapping of shipment to its manifest. | None required |
| inject_missing_state | Injects a missing state into the state transition process. |
|
| check_and_restore_promo | Checks for and restores any applicable promotional offers for the shipment. | None required |
| reassign_dp | Reassigns the shipment to a different delivery partner. | None required |
| update_article_and_store_data | Updates article and store configuration data when the store is reassigned. | None required |
| inventory_movement | Manages inventory depletion, handling movements from one state to another. |
|
| check_and_init_refund | Checks the status of a refund request and initializes the refund process. |
|
| assign_shipment_to_dp | Assigns the shipment to a courier partner. | None required |
| fetch_new_courier_partner_data | Fetches courier partner data from Stormbreaker based on the journey type. | None required |
| configure_clear_cart | Clears the customer's cart when enabled. | None required |
| configure_coupon | Restores coupons once all bags are cancelled. | None required |
task
string
Name of the hook that has to be added
kwargs
object
Additional parameters for the hook
filter
object (Filter)
Criteria to filter which hooks are applied based on certain conditions.
Show
Pass filters to set specific conditions
order_type
string
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
is_partial_transition
boolean
Specifies whether a partial transition of the order is allowed, allowing some components to progress while others remain in the current state.
auto_trigger_dp_assignment_acf
boolean
Indicates whether the assignment of a designated person is automatically triggered in the context of ACF.
lock_status
string
Indicates the current locking status of the shipment.
Enum
lock_after_transition
boolean
Specifies whether locking is required after transitioning to the next status.
lock_after_transition : true - Lock Transition enabled
lock_after_transition : false - Lock Transition set false
resume_tasks_after_unlock
boolean
Indicates whether tasks should resume automatically after unlocking, such as DP assignment task and invoicing task.
is_invoice_id_present
boolean
Indicates whether an invoice ID is present for the order.
is_credit_note_generated
boolean
Indicates whether a credit note has been generated for the order.
fulfill_virtual_invoice
boolean
Specifies whether an automated virtual invoice ID is associated with the order.
next_status
string
Indicates the next status to which the order will transition.
Enum
is_hook_enabled
boolean
Indicates whether a task is enabled for the order.
pos_credit_note_check
boolean
Specifies whether a credit note check is performed in a point of sale (POS) scenario.
order_platform
string
Specifies the platform on which the order was placed.
Enum
refund_type
string
Indicates the type of refund associated with the order.
Enum
is_non_pos_platform
boolean
Specifies whether the platform is non-point of sale (POS) in nature.
is_self_ship
boolean
Indicates whether the order is self-shipped by the seller.
seller_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `seller_country_code`: US
- `seller_country_code`: UK
- `seller_country_code`: IN
customer_country_code
string
Specifies the country code of the seller in ISO 3166-1 alpha-2 format.
- `customer_country_code`: US
- `customer_country_code`: UK
- `customer_country_code`: IN
is_test_order
boolean
Indicates whether the order is a test order used for testing purposes - `is_test_order` : True - indicates test order
task_trigger_condition
array of string
Specifies trigger conditions:
- `status_update`: Status Update
- `data_update`: Data Update
Enum
fulfillment_option_slug
string
Represents the unique slug associated with the fulfillment option attached to the shipment.
This slug helps determine the fulfillment method and operational flow used to deliver the shipment.
Examples:
- "standard-delivery"
- "hyperlocal-delivery"
flags
object (Flags)
Various flags related to the transition. These include options and settings that influence the behavior of the state transition, such as whether partial transitions are allowed or whether the transition can break the entity.
Show
allow_partial_transition
array of object (FlagData)
Indicates whether a partial transition of bags to the next state is permissible,
allowing some bags to progress while others remain in the current state.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
can_break_entity
array of object (FlagData)
Specifies whether bags within a shipment, set,cdf or entity can be broken individually or as a group.
If set to false, all bags within the entity must remain together and transition together to the same state.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_bag_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at the bag level.
Allowed fields are:
- meta
- pdf_links
- affiliate_meta
- delivery_awb_number
- store_invoice_id
- store_id
- return_store_id
- eway_bill_id
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_bag_status_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at the bag status level.
Allowed fields are:
- json
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_entity_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at shipment level.
Allowed fields are:
- meta
- pdf_links
- affiliate_meta
- delivery_awb_number
- store_invoice_id
- store_id
- return_store_id
- eway_bill_id
- logistics_meta
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
allowed_entity_status_updates
array of object (FlagData)
Specifies which fields are permitted to be updated at the Entity status level.
Allowed fields are:
- json
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
status_update_type
array of object (FlagData)
Describes the type of journey associated with the particular status of the shipment.
Possible values are:
- positive
- negative
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_bag_status_reason_allowed
array of object (FlagData)
Indicates whether a reason at the product level should be allowed for a particular status.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_entity_status_reason_allowed
array of object (FlagData)
Indicates whether a reason at the shipment level should be allowed for a particular status.
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
transition_strategy
array of object (FlagData)
This flag is used to define the shipment breaking strategy.
Possible values are:
- break_shipment_based_on_location_reassignment
- break_shipment_based_on_groups
- break_shipment_based_on_stormbreaker
Show
Specifies value of the flags that define the behavior of state transitions, such as allowing partial transitions, permitted keys for update on shipments and bags in specific states.
filter
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
Retrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
getStateManagerConfig
The Payment module is responsible for handling payment methods operations. These will include updating payment mode of entities.
Operations
PUT
# Update payment details for an order, its shipments and its bags.
Updates the payment mode for an order, its shipments and its bags. This endpoint allows for modifying payment methods, and associated details but not amount.
Parameters
company_idpath
string
Required
bodyrequestBody
object (UpdateShipmentPaymentMode)
Required
Hide
An object containing the shipment identifier, a list of shipment-level payment methods, and a list of products with their respective payment methods to be overridden.
shipment_id
string
Required
Unique identifier used to filter the shipment.
products
array of object (ProductSchema)
List of products attached with the shipment against which the payment methods needs to be overridden.
Show
An object containing the line number of a product to uniquely identify it within the shipment and the relevant list of payment methods that need to be updated or overridden for that product.
line_number
integer
Required
The line number of a product used to uniquely identify and filter the specific product within the shipment.
payment_methods
array of object (PaymentMethodSchema)
Required
List of payment methods that needs to be updated against filtered product.
Show
An object containing detailed data of a payment method.
name
string
Required
The name of the payment method (e.g., "Credit Card", "PayPal").
mode
string
Required
The mode of payment (e.g., "PREPAID", "COD").
amount
number
| float
Required
The amount to be paid using this payment method.
meta
object (PaymentMetaDataSchema)
Show
meta data for the payment method.
payment_gateway
string
The name or identifier of the payment gateway used.
payment_identifier
string
A unique identifier for this payment transaction.
logo_url
object (PaymentMetaLogoURLSchema)
Show
Logo for the payment method to be shown.
large
string
Required
URL for the large version of the payment method's logo.
small
string
Required
URL for the small version of the payment method's logo.
identifier
string
Required
Unique identifier for this payment method.
display_name
string
Required
The name to be displayed for this payment method.
aggregator
string
Required
The payment aggregator or service provider used for this payment method.
action
object (ActionDetailSchema)
Required
Show
action data for the payment method, based on which we going to update/overwrite the payment methods
name
Undefined Type
Required
The type of action to be performed (currently only "override" is supported).
Enum
current_mode
string
Required
The current payment mode before the action is applied.
current_identifier
string
Required
The current identifier of the payment method before the action is applied.
refund_to
string
Specifies where the refund should be directed to, if applicable.
refund_by
string
Required
Payment refund by for the customer and seller (e.g fynd, seller).
collect_by
string
Required
Payment collected by for the customer and seller (e.g fynd, seller).
payment_methods
array of object (PaymentMethodSchema)
List of payment methods that needs to be updated on shipment level.
Show
An object containing detailed data of a payment method.
name
string
Required
The name of the payment method (e.g., "Credit Card", "PayPal").
mode
string
Required
The mode of payment (e.g., "PREPAID", "COD").
amount
number
| float
Required
The amount to be paid using this payment method.
meta
object (PaymentMetaDataSchema)
Show
meta data for the payment method.
payment_gateway
string
The name or identifier of the payment gateway used.
payment_identifier
string
A unique identifier for this payment transaction.
logo_url
object (PaymentMetaLogoURLSchema)
Show
Logo for the payment method to be shown.
large
string
Required
URL for the large version of the payment method's logo.
small
string
Required
URL for the small version of the payment method's logo.
identifier
string
Required
Unique identifier for this payment method.
display_name
string
Required
The name to be displayed for this payment method.
aggregator
string
Required
The payment aggregator or service provider used for this payment method.
action
object (ActionDetailSchema)
Required
Show
action data for the payment method, based on which we going to update/overwrite the payment methods
name
object
Required
The type of action to be performed (currently only "override" is supported).
Enum
current_mode
string
Required
The current payment mode before the action is applied.
current_identifier
string
Required
The current identifier of the payment method before the action is applied.
refund_to
string
Specifies where the refund should be directed to, if applicable.
refund_by
string
Required
Payment refund by for the customer and seller (e.g fynd, seller).
collect_by
string
Required
Payment collected by for the customer and seller (e.g fynd, seller).
Request body
shipment_id
string
Required
Unique identifier used to filter the shipment.
products
array of object (ProductSchema)
List of products attached with the shipment against which the payment methods needs to be overridden.
Show
An object containing the line number of a product to uniquely identify it within the shipment and the relevant list of payment methods that need to be updated or overridden for that product.
line_number
integer
Required
The line number of a product used to uniquely identify and filter the specific product within the shipment.
payment_methods
array of object (PaymentMethodSchema)
Required
List of payment methods that needs to be updated against filtered product.
Show
An object containing detailed data of a payment method.
name
string
Required
The name of the payment method (e.g., "Credit Card", "PayPal").
mode
string
Required
The mode of payment (e.g., "PREPAID", "COD").
amount
number
| float
Required
The amount to be paid using this payment method.
meta
object (PaymentMetaDataSchema)
Show
meta data for the payment method.
payment_gateway
string
The name or identifier of the payment gateway used.
payment_identifier
string
A unique identifier for this payment transaction.
logo_url
object (PaymentMetaLogoURLSchema)
Show
Logo for the payment method to be shown.
large
string
Required
URL for the large version of the payment method's logo.
small
string
Required
URL for the small version of the payment method's logo.
identifier
string
Required
Unique identifier for this payment method.
display_name
string
Required
The name to be displayed for this payment method.
aggregator
string
Required
The payment aggregator or service provider used for this payment method.
action
object (ActionDetailSchema)
Required
Show
action data for the payment method, based on which we going to update/overwrite the payment methods
name
object
Required
The type of action to be performed (currently only "override" is supported).
Enum
current_mode
string
Required
The current payment mode before the action is applied.
current_identifier
string
Required
The current identifier of the payment method before the action is applied.
refund_to
string
Specifies where the refund should be directed to, if applicable.
refund_by
string
Required
Payment refund by for the customer and seller (e.g fynd, seller).
collect_by
string
Required
Payment collected by for the customer and seller (e.g fynd, seller).
payment_methods
array of object (PaymentMethodSchema)
List of payment methods that needs to be updated on shipment level.
Show
An object containing detailed data of a payment method.
name
string
Required
The name of the payment method (e.g., "Credit Card", "PayPal").
mode
string
Required
The mode of payment (e.g., "PREPAID", "COD").
amount
number
| float
Required
The amount to be paid using this payment method.
meta
object (PaymentMetaDataSchema)
Show
meta data for the payment method.
payment_gateway
string
The name or identifier of the payment gateway used.
payment_identifier
string
A unique identifier for this payment transaction.
logo_url
object (PaymentMetaLogoURLSchema)
Show
Logo for the payment method to be shown.
large
string
Required
URL for the large version of the payment method's logo.
small
string
Required
URL for the small version of the payment method's logo.
identifier
string
Required
Unique identifier for this payment method.
display_name
string
Required
The name to be displayed for this payment method.
aggregator
string
Required
The payment aggregator or service provider used for this payment method.
action
object (ActionDetailSchema)
Required
Show
action data for the payment method, based on which we going to update/overwrite the payment methods
name
object
Required
The type of action to be performed (currently only "override" is supported).
Enum
current_mode
string
Required
The current payment mode before the action is applied.
current_identifier
string
Required
The current identifier of the payment method before the action is applied.
refund_to
string
Specifies where the refund should be directed to, if applicable.
refund_by
string
Required
Payment refund by for the customer and seller (e.g fynd, seller).
collect_by
string
Required
Payment collected by for the customer and seller (e.g fynd, seller).
PUT
Response
200
422
The request was successful, and the payment mode has been updated for the specified order and shipments.
Hide
success
boolean
message
string
Response
Update payment details for an order, its shipments and its bags.
updatePaymentInfo
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
POST
# Reassign location
POST
# Update a shipment lock
PUT
# Update shipment address
PUT
# Update a shipment's status
GET
# Get a shipment's history
POST
# Create shipment history
POST
# Update packaging dimensions
POST
# Send user mobile OTP
POST
# Verify mobile OTP
POST
# Retry E-invoice
GET
# Track shipment
POST
# Update shipment tracking
POST
# Generate and attach invoice Id
GET
# Get shipment packages
POST
# Create shipment packages
PUT
# Update shipment packages
POST
# Manually request a courier partner for a shipment.
POST
# Save courier partner preference for a shipment.
GET
# List shipments
GET
# Get shipment details
Reassign the shipment to a another location and update its status to 'Store Reassigned.'
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
bodyrequestBody
object (StoreReassign)
Required
Hide
store_id
integer
| int32
Required
Unique id of the store.
bag_id
integer
| int32
Nullable
Identifier for the bag associated with the reassignment.
affiliate_order_id
string
Nullable
Identifier for the affiliate order id associated with the reassignment.
affiliate_id
string
Nullable
Identifier for the affiliate id associated with the reassignment.
item_id
string
Nullable
Identifier for the item associated with the reassignment.
fynd_order_id
string
Nullable
Identifier for the fynd order id associated with the reassignment.
Maximum Length : 30
set_id
string
Nullable
Identifier for the set of items associated with the reassignment.
affiliate_bag_id
string
Nullable
Identifiers for bags associated with the reassignment.
reason_ids
array of integer
Nullable
List of reason ids for the reassignment.
mongo_article_id
string
Nullable
Identifier for the article id associated with the reassignment.
Request body
store_id
integer
| int32
Required
Unique id of the store.
bag_id
integer
| int32
Nullable
Identifier for the bag associated with the reassignment.
affiliate_order_id
string
Nullable
Identifier for the affiliate order id associated with the reassignment.
affiliate_id
string
Nullable
Identifier for the affiliate id associated with the reassignment.
item_id
string
Nullable
Identifier for the item associated with the reassignment.
fynd_order_id
string
Nullable
Identifier for the fynd order id associated with the reassignment.
Maximum Length : 30
set_id
string
Nullable
Identifier for the set of items associated with the reassignment.
affiliate_bag_id
string
Nullable
Identifiers for bags associated with the reassignment.
reason_ids
array of integer
Nullable
List of reason ids for the reassignment.
mongo_article_id
string
Nullable
Identifier for the article id associated with the reassignment.
POST
Response
200
Successfully reassigned location!
Hide
success
boolean
Indicates whether the API call was successful (true) or not (false).
message
string
A descriptive message providing additional information about the API response.
Examples
Parameters
Parameters are not required.
Response
Reassign location
reassignLocation
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
bodyrequestBody
object (UpdateShipmentLockPayload)
Required
Hide
entity_type
string
Required
Specifies the type of entity being locked or unlocked.
Enum
action
string
Required
Indicates the action to be performed on the entity.
Enum
action_type
string
Required
Defines the current lock state or lock type of a shipment, dictating the types of transitions or actions that can be performed next.The action_type can be one of the following - complete- Complete lock specifies that no action can be performed for that shipment. - operational- The shipment is in an operational phase, during which only financial-related actions are permissible. - financial- The shipment is in a financial phase, allowing for operational actions to be taken.
Enum
entities
array of object (LockManagerEntities)
Required
List of entities to be locked or unlocked
Show
id
string
Shipment ID if 'entity_type': shipments | Bag Id if 'entity_type': bags
affiliate_order_id
string
External identifier for the order id associated with shipment.
affiliate_id
string
Identifier for application associated with the shipment.
reason_text
string
Required
A descriptive reason text for lock/unlock action of a shipment/bag.
affiliate_bag_id
string
External identifier for the bag id associated with orders/shipment.
affiliate_shipment_id
string
External identifier for the shipment id associated with orders/shipment.
resume_tasks_after_unlock
boolean
Nullable
Indicates whether tasks should resume automatically after unlocking, such as DP assignment task and invoicing task.
lock_after_transition
boolean
Specifies whether the shipment should be locked automatically after a transition occurs.
unlock_before_transition
boolean
Specifies whether the shipment should be unlocked before a transition occurs.
Request body
entity_type
string
Required
Specifies the type of entity being locked or unlocked.
Enum
action
string
Required
Indicates the action to be performed on the entity.
Enum
action_type
string
Required
Defines the current lock state or lock type of a shipment, dictating the types of transitions or actions that can be performed next.The action_type can be one of the following - complete- Complete lock specifies that no action can be performed for that shipment. - operational- The shipment is in an operational phase, during which only financial-related actions are permissible. - financial- The shipment is in a financial phase, allowing for operational actions to be taken.
Enum
entities
array of object (LockManagerEntities)
Required
List of entities to be locked or unlocked
Show
id
string
Shipment ID if 'entity_type': shipments | Bag Id if 'entity_type': bags
affiliate_order_id
string
External identifier for the order id associated with shipment.
affiliate_id
string
Identifier for application associated with the shipment.
reason_text
string
Required
A descriptive reason text for lock/unlock action of a shipment/bag.
affiliate_bag_id
string
External identifier for the bag id associated with orders/shipment.
affiliate_shipment_id
string
External identifier for the shipment id associated with orders/shipment.
resume_tasks_after_unlock
boolean
Nullable
Indicates whether tasks should resume automatically after unlocking, such as DP assignment task and invoicing task.
lock_after_transition
boolean
Specifies whether the shipment should be locked automatically after a transition occurs.
unlock_before_transition
boolean
Specifies whether the shipment should be unlocked before a transition occurs.
POST
Response
200
Successfully updated the Lock and get check status of the shipment/Bag
Hide
success
boolean
Indicates whether the API call was successful (true) or not (false).
message
string
A descriptive message providing additional information about the API response, such as success confirmation or error details.
check_response
array of object (CheckResponseSchema)
An array containing the lock status of entities if the action performed was a 'check'. Each item in the array represents the status of a specific entity.
Show
shipment_id
string
Shipment ID
status
string
Status
is_bag_locked
boolean
Is Bag Locked
affiliate_id
string
Affiliate ID
original_filter
object (OriginalFilter)
Filter
Show
affiliate_shipment_id
string
Affiliate Shipment ID
affiliate_id
string
Affiliate ID
is_shipment_locked
boolean
Is Shipment Locked
lock_status
string
Nullable
Lock Status: Expected lock_status: [complete, operational, financial]
affiliate_shipment_id
string
Affiliate Shipment ID
bags
array of object (Bags)
Show
bag_id
integer
| int32
Bag Id
affiliate_bag_id
string
Application/Affiliate Bag ID, Required if the ID is missing
is_locked
boolean
Is Bag Locked
affiliate_order_id
string
Application/Affiliate Order ID, Required if the ID is missing
Examples
Parameters
Parameters are not required.
Response
Update a shipment lock
updateShipmentLock
Update the address details of an existing shipment based on the provided address_category. This operation allows the modification of critical shipment details, potentially affecting delivery/billing accuracy and customer communication.
Parameters
company_idpath
integer
Required
ID of the company fulfilling the shipment
shipment_idpath
string
Required
Unique shipment no. that is auto-generated
bodyrequestBody
object (UpdateAddressRequestBody)
Required
Hide
updated_address
object (UpdatedAddressSchema)
Show
The new address details to update.
address
string
The complete address.
area
string
The locality or area associated with the address.
landmark
string
A prominent nearby landmark for locating the address.
pincode
string
The postal code (for example, zip, postcode, or Eircode) of the address.
city
string
The city, town, or village of the address.
state
string
The state or province of the address.
name
string
The name of the person associated with the address.
phone
string
Phone number associated with the address user.
email
string
Email address associated with the address user.
country
string
The country of the address.
country_iso_code
string
The ISO code representing the country of the address.
latitude
number
| double
The latitude of the address.
longitude
number
| double
The longitude of the address.
address_type
string
The type of address (e.g., office, home).
Enum
address_category
string
The category of the address (e.g., delivery, billing).
Enum
Request body
updated_address
object (UpdatedAddressSchema)
Show
The new address details to update.
address
string
The complete address.
area
string
The locality or area associated with the address.
landmark
string
A prominent nearby landmark for locating the address.
pincode
string
The postal code (for example, zip, postcode, or Eircode) of the address.
city
string
The city, town, or village of the address.
state
string
The state or province of the address.
name
string
The name of the person associated with the address.
phone
string
Phone number associated with the address user.
email
string
Email address associated with the address user.
country
string
The country of the address.
country_iso_code
string
The ISO code representing the country of the address.
latitude
number
| double
The latitude of the address.
longitude
number
| double
The longitude of the address.
address_type
string
The type of address (e.g., office, home).
Enum
address_category
string
The category of the address (e.g., delivery, billing).
Enum
PUT
Response
200
Updated Address will be processed!
Hide
success
boolean
Indicates whether the API call was successful (true) or not (false).
message
string
A descriptive message providing additional information about the API response.
Examples
Parameters
Parameters are not required.
Response
Update shipment address
updateAddress
It is used for updating the shipment in the following scenarios: Full Confirmation, Partial Confirmation, Change the status of a shipment, Full Cancellation, Partial Cancellation, Assign the shipment to DP. Click here to get the use case details.
Parameters
company_idpath
integer
Required
Company id from where are transitioning the shipment state or data
bodyrequestBody
object (UpdateShipmentStatusRequestSchema)
Required
Hide
force_transition
boolean
Indicates whether to force the status transition, overriding any restrictions or checks that may normally apply.
statuses
array of object (StatuesRequestSchema)
A list of status updates to be applied to the shipment.
Show
status
string
The new status to be assigned to a shipment. Also, refer to the OMS States for the complete status list.
shipments
array of object (ShipmentsRequestSchema)
A list of shipments to which the new status will be applied.
Show
identifier
string
Required
Unique identifier for the shipment.
reasons
object (ReasonsData)
Show
products
array of object (ProductsReasons)
A list of reasons specifically related to products involved in the shipment.
Show
filters
array of object (ProductsReasonsFilters)
A list of filters applied to specify which products the reasons pertain to.
Show
line_number
integer
| int32
The line number for the product or bag, which helps identify the specific item in a list or order.
identifier
string
The unique article or item identifier for the product or bag.
quantity
integer
| int32
The quantity of the product or bag being referenced.
data
object (ProductsReasonsData)
Show
reason_text
string
A descriptive text providing the reason for the action or status associated with the product or bag.
reason_id
integer
| int32
A unique identifier for the reason, used to reference specific reasons in the system.
entities
array of object (EntitiesReasons)
A list of reasons specifically related to shipment.
Show
filters
array of object
A list of filters applied to specify which entities the reasons pertain to.
data
object (EntityReasonData)
Show
reason_text
string
A descriptive text providing the reason for the action or status associated with the product or bag.
reason_id
integer
| int32
A unique identifier for the reason, used to reference specific reasons in the system.
products
array of object (Products)
A list of products or bags that need to be updated as part of the shipment status change.
Show
line_number
integer
| int32
The line number for the product or bag, which helps identify the specific item in a list or order.
identifier
string
The unique article or item identifier for the product or bag.
quantity
integer
| int32
The quantity of the product or bag being referenced.
data_updates
object (DataUpdates)
Show
order_item_status
array of object (OrderItemDataUpdates)
A list of updates related to the status of order items.
Show
data
object
Contains the specific data for updating shipment bags data.
products
array of object (ProductsDataUpdates)
A list of updates related to the properties of products or bags.
Show
filters
array of object (ProductsDataUpdatesFilters)
A list of filters applied to specify which products or bags are targeted for updates.
Show
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.
data
object
Contains the specific data for updating the products or bags.
entities
array of object (EntitiesDataUpdates)
A list of updates related to the properties of any relevant entities.
Show
filters
array of object
A list of filters used to specify which shipments are targeted for updates.
data
object
Encapsulates a dynamic set of updates and modifications applied to the entity.
order
array of object (OrderDataUpdates)
Show
data
object
Encapsulates a dynamic set of updates and modifications applied to the order.
entity_status
array of object (EntityStatusDataUpdates)
A list of updates to entity_status properties associated with specific shipment status transitions (e.g., bag_confirmed, return_accepted). These updates are optional. Update e.g., inventory-affecting data (like QC data) to be updated.
Show
filters
array of object (DataUpdatesFiltersSchema)
A list of filters used to specify the target for this update. For shipment level or shipment-status level updates, this should be an empty array ([]) as no filters are required during shipment/shipment_status transitions. But is still mandatory due to schema requirements. For product-level updates, appropriate filters must be provided as per the schema to accurately target specific items.
Show
line_number
integer
Line number of the product/bag.
quantity
integer
Quantity of the line number item.
identifier
string
Seller identifier of the product/bag.
data
object (EntityStatusDataSchema)
Show
seller_qc_details
array of object (SellerQCDetailsSchema)
An array of QC results provided by the seller to indicate the condition of returned items (e.g., good vs. bad quantity) for each line item. Pass this field such that if inventory-related data is included, it will be updated accordingly during the transition.
Show
line_number
integer
Required
line_number of the product/bag.
good_quantity
integer
Required
The number of units marked as good during the seller QC process for the given line_number/bag item.
bad_quantity
integer
Required
The number of units marked as bad during the seller QC process for the given line_number/bag item.
transition_comments
array of object (TransitionComments)
Comments or notes associated with the transition of shipment status.
Show
title
string
Required
Title for the transition message.
message
string
Required
Message for the transition.
refund_modes
array of object (RefundModeTransitionData)
Refund Mode for status transition.
Show
Refund Mode Transition Data for status transition.
refund_mode
string
Refund Mode for status transition data.
display_name
string
Refund Mode display name.
payment_identifiers
array of string
List of identifiers associated with the refund transaction.
exclude_bags_next_state
string
Specifies the state to which remaining bags or products should be changed, effectively excluding them from the current status update.
split_shipment
boolean
A flag indicating whether the shipment should be split into multiple parts. If set to true, the shipment will be divided according to the specified logic or criteria.
lock_after_transition
boolean
Specifies whether the shipment should be locked automatically after a transition occurs.
unlock_before_transition
boolean
Specifies whether the shipment should be unlocked before a transition occurs.
task
boolean
Indicates whether to run the status update as a background task, allowing other processes to continue without waiting for this operation to complete.
resume_tasks_after_unlock
boolean
Indicates whether tasks should resume automatically after unlocking, such as DP assignment task and invoicing task.
Request body
force_transition
boolean
Indicates whether to force the status transition, overriding any restrictions or checks that may normally apply.
statuses
array of object (StatuesRequestSchema)
A list of status updates to be applied to the shipment.
Show
status
string
The new status to be assigned to a shipment. Also, refer to the OMS States for the complete status list.
shipments
array of object (ShipmentsRequestSchema)
A list of shipments to which the new status will be applied.
Show
identifier
string
Required
Unique identifier for the shipment.
reasons
object (ReasonsData)
Show
products
array of object (ProductsReasons)
A list of reasons specifically related to products involved in the shipment.
Show
filters
array of object (ProductsReasonsFilters)
A list of filters applied to specify which products the reasons pertain to.
Show
line_number
integer
| int32
The line number for the product or bag, which helps identify the specific item in a list or order.
identifier
string
The unique article or item identifier for the product or bag.
quantity
integer
| int32
The quantity of the product or bag being referenced.
data
object (ProductsReasonsData)
Show
reason_text
string
A descriptive text providing the reason for the action or status associated with the product or bag.
reason_id
integer
| int32
A unique identifier for the reason, used to reference specific reasons in the system.
entities
array of object (EntitiesReasons)
A list of reasons specifically related to shipment.
Show
filters
array of object
A list of filters applied to specify which entities the reasons pertain to.
data
object (EntityReasonData)
Show
reason_text
string
A descriptive text providing the reason for the action or status associated with the product or bag.
reason_id
integer
| int32
A unique identifier for the reason, used to reference specific reasons in the system.
products
array of object (Products)
A list of products or bags that need to be updated as part of the shipment status change.
Show
line_number
integer
| int32
The line number for the product or bag, which helps identify the specific item in a list or order.
identifier
string
The unique article or item identifier for the product or bag.
quantity
integer
| int32
The quantity of the product or bag being referenced.
data_updates
object (DataUpdates)
Show
order_item_status
array of object (OrderItemDataUpdates)
A list of updates related to the status of order items.
Show
data
object
Contains the specific data for updating shipment bags data.
products
array of object (ProductsDataUpdates)
A list of updates related to the properties of products or bags.
Show
filters
array of object (ProductsDataUpdatesFilters)
A list of filters applied to specify which products or bags are targeted for updates.
Show
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.
data
object
Contains the specific data for updating the products or bags.
entities
array of object (EntitiesDataUpdates)
A list of updates related to the properties of any relevant entities.
Show
filters
array of object
A list of filters used to specify which shipments are targeted for updates.
data
object
Encapsulates a dynamic set of updates and modifications applied to the entity.
order
array of object (OrderDataUpdates)
Show
data
object
Encapsulates a dynamic set of updates and modifications applied to the order.
entity_status
array of object (EntityStatusDataUpdates)
A list of updates to entity_status properties associated with specific shipment status transitions (e.g., bag_confirmed, return_accepted). These updates are optional. Update e.g., inventory-affecting data (like QC data) to be updated.
Show
filters
array of object (DataUpdatesFiltersSchema)
A list of filters used to specify the target for this update. For shipment level or shipment-status level updates, this should be an empty array ([]) as no filters are required during shipment/shipment_status transitions. But is still mandatory due to schema requirements. For product-level updates, appropriate filters must be provided as per the schema to accurately target specific items.
Show
line_number
integer
Line number of the product/bag.
quantity
integer
Quantity of the line number item.
identifier
string
Seller identifier of the product/bag.
data
object (EntityStatusDataSchema)
Show
seller_qc_details
array of object (SellerQCDetailsSchema)
An array of QC results provided by the seller to indicate the condition of returned items (e.g., good vs. bad quantity) for each line item. Pass this field such that if inventory-related data is included, it will be updated accordingly during the transition.
Show
line_number
integer
Required
line_number of the product/bag.
good_quantity
integer
Required
The number of units marked as good during the seller QC process for the given line_number/bag item.
bad_quantity
integer
Required
The number of units marked as bad during the seller QC process for the given line_number/bag item.
transition_comments
array of object (TransitionComments)
Comments or notes associated with the transition of shipment status.
Show
title
string
Required
Title for the transition message.
message
string
Required
Message for the transition.
refund_modes
array of object (RefundModeTransitionData)
Refund Mode for status transition.
Show
Refund Mode Transition Data for status transition.
refund_mode
string
Refund Mode for status transition data.
display_name
string
Refund Mode display name.
payment_identifiers
array of string
List of identifiers associated with the refund transaction.
exclude_bags_next_state
string
Specifies the state to which remaining bags or products should be changed, effectively excluding them from the current status update.
split_shipment
boolean
A flag indicating whether the shipment should be split into multiple parts. If set to true, the shipment will be divided according to the specified logic or criteria.
lock_after_transition
boolean
Specifies whether the shipment should be locked automatically after a transition occurs.
unlock_before_transition
boolean
Specifies whether the shipment should be unlocked before a transition occurs.
task
boolean
Indicates whether to run the status update as a background task, allowing other processes to continue without waiting for this operation to complete.
resume_tasks_after_unlock
boolean
Indicates whether tasks should resume automatically after unlocking, such as DP assignment task and invoicing task.
PUT
Response
200
The successful response can contain both success or failure information. In case of failure, the response will still return with HTTP 200 status, but will specify the failed items/reasons within the response payload.
Hide
statuses
array of object (StatuesResponseSchema)
List of statuses of the shipments after a status update operation. Includes an array of status objects, each containing details about shipments that have undergone data updates.
Show
shipments
array of object (ShipmentsResponseSchema)
List of Shipments which includes data for each shipment, the current status code, final state information including reasons for cancellation (if applicable), and unique shipment identifiers are provided.
Show
status
integer
| int32
Nullable
final_state
object
Nullable
identifier
string
Nullable
stack_trace
string
Nullable
code
string
Nullable
meta
object
Nullable
message
string
Nullable
exception
string
Nullable
Response
Update a shipment's status
updateShipmentStatus
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
shipment_idquery
string
Identifier for the shipment
bag_idquery
integer
Identifier for a bag or product.
GET
Response
200
It shows the journey of the shipment!
Hide
success
boolean
Indicates whether the API call was successful (true) or not (false).
activity_history
array of object (HistoryDict)
A list of activity records related to the shipment, providing details on actions taken, comments added, or notifications sent.
Show
display_message
string
User-friendly message displaying the activity or status change.
bag_id
integer
| int32
Identifier for the bag associated with the activity.
ticket_url
string
URL for any related tickets.
l3_detail
string
L3 details regarding the bag or activity.
createdat
string
Date and time when the activity was created.
created_ts
string
Timestamp for when the activity was created in ISO format.
ticket_id
string
Unique identifier for the ticket associated with the activity.
activity_type
string
Defines the category of event-related information for a shipment, indicating the nature of the update. This includes whether the update pertains to the status of the shipment, comments added to it, or notifications about specific events.
Enum
l2_detail
string
L2 details regarding the bag or activity.
assigned_agent
string
Name of the agent assigned to the activity.
meta
object (HistoryMeta)
Show
Metadata about the activity
store_id
integer
| int32
Nullable
Unique identifier for the store involved in the activity.
status
string
Nullable
Current status of the activity or item.
status1
string
Nullable
Additional status information if necessary.
call_id
string
Nullable
Identifier for any related calls, if applicable.
starttime
string
Nullable
Start time of the activity.
reason
object (HistoryReason)
Show
text
string
Nullable
A reason for the activity or change.
category
string
Nullable
Category of the reason for the status change.
state
string
Nullable
Current state related to the reason.
display_name
string
Nullable
Display name of the reason for better user understanding.
code
integer
| int32
Nullable
Unique code identifying the reason.
quantity
integer
| int32
Nullable
Quantity related to the reason, if applicable.
short_link
string
Nullable
A shortened link related to the activity, if available.
endtime
string
Nullable
End time of the activity.
store_name
string
Nullable
Name of the store involved in the activity.
caller
string
Nullable
Name of the caller associated with the activity.
store_code
string
Nullable
Code associated with the store.
billsec
string
Nullable
Duration of the billable period, if applicable.
recordpath
string
Nullable
Path to any related recordings, if applicable.
status2
string
Nullable
Additional status information if necessary.
callerid
string
Nullable
Caller ID associated with the activity, if applicable.
duration
string
Nullable
Total duration of the activity.
channel_type
string
Nullable
Type of channel used for the activity, if applicable.
Enum
activity_comment
string
Nullable
Comments related to the activity, if applicable.
activity_type
string
Nullable
Defines the category of event-related information for a shipment, indicating the nature of the update. This includes whether the update pertains to the status of the shipment, comments added to it, or notifications about specific events.
Enum
receiver
string
Nullable
Name of the receiver involved in the activity, if applicable.
recipient
string
Nullable
Recipient of the activity, if applicable.
slug
string
Nullable
Slug identifier for the activity.
message
string
Nullable
Any additional messages related to the activity.
prev_store_name
string
Nullable
The name of the store where the item was previously located before being transferred or processed. This field can be null if the previous store information is not applicable or available.
prev_store_code
string
Nullable
The unique code associated with the previous store. This code helps identify the store in the system and can be null if the previous store code is not recorded or required.
prev_store_id
string
Nullable
The unique identifier (ID) of the previous store in the database or system. This ID can be null if the previous store information is not relevant or if the store did not have a designated ID.
refund_to
string
Nullable
The destination or method by which a refund will be issued. This indicates where the refunded amount will be sent, such as back to the original payment source (e.g., 'Back To Source').
refund_information
array of object (RefundInformation)
Show
mode
string
The payment method used for the order, such as CARD, Net Banking (NB), or other options. This field indicates how the original payment was made and will determine how the refund is processed.
amount
number
| float
The amount to be refunded, represented as a floating-point number. This specifies the exact value that will be returned to the customer.
merchant_transaction_id
string
A unique identifier associated with the payment transaction, such as TR669796C0012CF31BBD. This ID helps track and reference the specific transaction within the merchant's system.
refund_status
string
The current status of the refund process, indicating whether the refund has been completed, is pending, or has encountered an issue (e.g., 'refund_done', 'refund_failed'). This field reflects the state of the refund operation.
l1_detail
string
L1 details regarding the bag or activity.
message
string
Message or comment regarding the history.
user
string
Name of the user who created the history record.
Response
Get a shipment's history
getShipmentHistory
Parameters
company_idpath
integer
Required
bodyrequestBody
object (PostShipmentHistory)
Required
Hide
activity_history
array of object (PostHistoryDict)
A list of activity history records, each adhering to the PostHistoryDict schema.
Show
filters
array of object (PostHistoryFilters)
Required
A list of filter objects, each following the PostHistoryFilters schema, used to identify which shipment history records are relevant.
Show
shipment_id
string
Required
Unique identifier for the shipment
line_number
string
Optional field to specify a particular line item in the shipment.
identifier
string
Optional field for any additional identifier related to the shipment.
data
object (PostHistoryData)
Required
Show
user_name
string
Required
The name or email of the user who performed the action or recorded the entry.
message
string
Required
A descriptive message detailing the action taken or the status related to the shipment.
Request body
activity_history
array of object (PostHistoryDict)
A list of activity history records, each adhering to the PostHistoryDict schema.
Show
filters
array of object (PostHistoryFilters)
Required
A list of filter objects, each following the PostHistoryFilters schema, used to identify which shipment history records are relevant.
Show
shipment_id
string
Required
Unique identifier for the shipment
line_number
string
Optional field to specify a particular line item in the shipment.
identifier
string
Optional field for any additional identifier related to the shipment.
data
object (PostHistoryData)
Required
Show
user_name
string
Required
The name or email of the user who performed the action or recorded the entry.
message
string
Required
A descriptive message detailing the action taken or the status related to the shipment.
POST
Response
200
It shows the journey of the shipment!
Hide
success
boolean
Indicates whether the API call was successful (true) or not (false).
activity_history
array of object (HistoryDict)
A list of activity records related to the shipment, providing details on actions taken, comments added, or notifications sent.
Show
display_message
string
User-friendly message displaying the activity or status change.
bag_id
integer
| int32
Identifier for the bag associated with the activity.
ticket_url
string
URL for any related tickets.
l3_detail
string
L3 details regarding the bag or activity.
createdat
string
Date and time when the activity was created.
created_ts
string
Timestamp for when the activity was created in ISO format.
ticket_id
string
Unique identifier for the ticket associated with the activity.
activity_type
string
Defines the category of event-related information for a shipment, indicating the nature of the update. This includes whether the update pertains to the status of the shipment, comments added to it, or notifications about specific events.
Enum
l2_detail
string
L2 details regarding the bag or activity.
assigned_agent
string
Name of the agent assigned to the activity.
meta
object (HistoryMeta)
Show
Metadata about the activity
store_id
integer
| int32
Nullable
Unique identifier for the store involved in the activity.
status
string
Nullable
Current status of the activity or item.
status1
string
Nullable
Additional status information if necessary.
call_id
string
Nullable
Identifier for any related calls, if applicable.
starttime
string
Nullable
Start time of the activity.
reason
object (HistoryReason)
Show
text
string
Nullable
A reason for the activity or change.
category
string
Nullable
Category of the reason for the status change.
state
string
Nullable
Current state related to the reason.
display_name
string
Nullable
Display name of the reason for better user understanding.
code
integer
| int32
Nullable
Unique code identifying the reason.
quantity
integer
| int32
Nullable
Quantity related to the reason, if applicable.
short_link
string
Nullable
A shortened link related to the activity, if available.
endtime
string
Nullable
End time of the activity.
store_name
string
Nullable
Name of the store involved in the activity.
caller
string
Nullable
Name of the caller associated with the activity.
store_code
string
Nullable
Code associated with the store.
billsec
string
Nullable
Duration of the billable period, if applicable.
recordpath
string
Nullable
Path to any related recordings, if applicable.
status2
string
Nullable
Additional status information if necessary.
callerid
string
Nullable
Caller ID associated with the activity, if applicable.
duration
string
Nullable
Total duration of the activity.
channel_type
string
Nullable
Type of channel used for the activity, if applicable.
Enum
activity_comment
string
Nullable
Comments related to the activity, if applicable.
activity_type
string
Nullable
Defines the category of event-related information for a shipment, indicating the nature of the update. This includes whether the update pertains to the status of the shipment, comments added to it, or notifications about specific events.
Enum
receiver
string
Nullable
Name of the receiver involved in the activity, if applicable.
recipient
string
Nullable
Recipient of the activity, if applicable.
slug
string
Nullable
Slug identifier for the activity.
message
string
Nullable
Any additional messages related to the activity.
prev_store_name
string
Nullable
The name of the store where the item was previously located before being transferred or processed. This field can be null if the previous store information is not applicable or available.
prev_store_code
string
Nullable
The unique code associated with the previous store. This code helps identify the store in the system and can be null if the previous store code is not recorded or required.
prev_store_id
string
Nullable
The unique identifier (ID) of the previous store in the database or system. This ID can be null if the previous store information is not relevant or if the store did not have a designated ID.
refund_to
string
Nullable
The destination or method by which a refund will be issued. This indicates where the refunded amount will be sent, such as back to the original payment source (e.g., 'Back To Source').
refund_information
array of object (RefundInformation)
Show
mode
string
The payment method used for the order, such as CARD, Net Banking (NB), or other options. This field indicates how the original payment was made and will determine how the refund is processed.
amount
number
| float
The amount to be refunded, represented as a floating-point number. This specifies the exact value that will be returned to the customer.
merchant_transaction_id
string
A unique identifier associated with the payment transaction, such as TR669796C0012CF31BBD. This ID helps track and reference the specific transaction within the merchant's system.
refund_status
string
The current status of the refund process, indicating whether the refund has been completed, is pending, or has encountered an issue (e.g., 'refund_done', 'refund_failed'). This field reflects the state of the refund operation.
l1_detail
string
L1 details regarding the bag or activity.
message
string
Message or comment regarding the history.
user
string
Name of the user who created the history record.
Examples
Parameters
Parameters are not required.
Response
Create shipment history
postShipmentHistory
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
bodyrequestBody
object (UpdatePackagingDimensionsPayload)
Required
Hide
shipment_id
string
Required
Unique identifier for the shipment for which the packaging dimensions are being updated.
current_status
string
Required
The current status of the shipment.
dimension
array of object (Dimension)
Required
A list of dimensions for the packaging.
Show
packaging_type
string
Defines the type of packaging used for the product, encompassing materials, design, and form factors.
weight
number
The weight of the package in kilograms.
height
number
The height of the package in centimetres.
length
number
The length of the package in centimetres.
width
number
The width of the package in centimetres.
Request body
shipment_id
string
Required
Unique identifier for the shipment for which the packaging dimensions are being updated.
current_status
string
Required
The current status of the shipment.
dimension
array of object (Dimension)
Required
A list of dimensions for the packaging.
Show
packaging_type
string
Defines the type of packaging used for the product, encompassing materials, design, and form factors.
weight
number
The weight of the package in kilograms.
height
number
The height of the package in centimetres.
length
number
The length of the package in centimetres.
width
number
The width of the package in centimetres.
POST
Response
200
Packaging Dimensions updated successfully
Hide
message
string
Examples
Parameters
Parameters are not required.
Response
Update packaging dimensions
updatePackagingDimensions
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
bodyrequestBody
object (SendUserMobileOTP)
Required
Hide
mobile
number
Required
The mobile phone number of the user to whom the OTP (One-Time Password) will be sent.
country_code
string
Uniquely identifies the country associated with the mobile number. This code is essential for for correctly formatting and routing the OTP messages to mobile phones across international borders. Examples include 'US' for the United States, 'IN' for India.
Request body
mobile
number
Required
The mobile phone number of the user to whom the OTP (One-Time Password) will be sent.
country_code
string
Uniquely identifies the country associated with the mobile number. This code is essential for for correctly formatting and routing the OTP messages to mobile phones across international borders. Examples include 'US' for the United States, 'IN' for India.
POST
Response
200
Send OTP to user mobile
Hide
success
boolean
Indicates whether the API call was successful (true) or not (false).
status
integer
The HTTP status code of the API response (200/400/500/503).
message
string
A descriptive message providing additional information about the API response.
data
object (PointBlankOtpData)
Show
request_id
string
A unique identifier for the OTP request.
resend_timer
integer
| int32
The amount of time (in seconds) before the OTP can be resent to the user.
message
string
A message providing additional information about the OTP request.
mobile
integer
The mobile number (in integer format) associated with the OTP request.
Examples
Parameters
Parameters are not required.
Response
Send user mobile OTP
sendUserMobileOTP
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
bodyrequestBody
object (VerifyMobileOTP)
Required
Hide
otp_data
object (VerifyOtpData)
Required
Show
request_id
string
Required
A unique identifier for the OTP verification request.
mobile
string
Required
The mobile number associated with the OTP verification.
otp_code
integer
| int32
Required
The OTP code received by the user.
fynd_order_id
string
Required
A unique identifier for the order associated with the OTP verification.
Request body
otp_data
object (VerifyOtpData)
Required
Show
request_id
string
Required
A unique identifier for the OTP verification request.
mobile
string
Required
The mobile number associated with the OTP verification.
otp_code
integer
| int32
Required
The OTP code received by the user.
fynd_order_id
string
Required
A unique identifier for the order associated with the OTP verification.
POST
Response
200
Verify OTP
Hide
status
integer
| int32
Represents the HTTP status code of the API response.
success
boolean
Indicates whether the API call was successful (true) or not (false).
message
string
A descriptive message providing additional information about the API response.
data
object (VerifyOtpResponseData)
Show
mobile
string
The mobile number associated with the verified OTP.
message
string
A string that provides a message about the outcome of the verification process.
fynd_order_id
string
Unique identifier for the order associated with the OTP verification.
country_code
string
A string indicating the country code associated with the mobile number.
Examples
Parameters
Parameters are not required.
Response
Verify mobile OTP
verifyMobileOTP
Parameters
company_idpath
integer
Required
bodyrequestBody
object (EInvoiceRetry)
Required
Hide
shipments_data
array of object (EInvoiceRetryShipmentData)
Show
shipment_id
string
Required
einvoice_type
string
Required
Defines the category or type of e-invoice generated for the shipment. This property must be set to one of the following values to qualify the shipment for e-invoice generation. invoice- A document detailing the sale, including goods, services, prices, and taxes, requesting payment. credit_note- Issued as an adjustment or correction to a previously issued invoice. It may indicate a reduction in the amount often due to reasons such as returned goods, overbilling, or a post-sale discount. A credit note effectively reverses or alters the charges outlined in the original invoice, either partially or in full.
Enum
Request body
shipments_data
array of object (EInvoiceRetryShipmentData)
Show
shipment_id
string
Required
einvoice_type
string
Required
Defines the category or type of e-invoice generated for the shipment. This property must be set to one of the following values to qualify the shipment for e-invoice generation. invoice- A document detailing the sale, including goods, services, prices, and taxes, requesting payment. credit_note- Issued as an adjustment or correction to a previously issued invoice. It may indicate a reduction in the amount often due to reasons such as returned goods, overbilling, or a post-sale discount. A credit note effectively reverses or alters the charges outlined in the original invoice, either partially or in full.
Enum
POST
Response
200
400
E-invoice generated successfully for all/few shipments from given list of shipments.
Hide
response_data
array of object (EInvoiceResponseData)
Show
shipment_id
string
einvoice_type
string
Defines the category or type of e-invoice generated for the shipment. This property must be set to one of the following values to qualify the shipment for e-invoice generation. invoice- A document detailing the sale, including goods, services, prices, and taxes, requesting payment. credit_note- Issued as an adjustment or correction to a previously issued invoice. It may indicate a reduction in the amount often due to reasons such as returned goods, overbilling, or a post-sale discount. A credit note effectively reverses or alters the charges outlined in the original invoice, either partially or in full.
Enum
status
integer
message
string
einvoice_info
object (EInvoiceDetails)
Show
irn_details
object (EInvoiceIrnDetails)
Show
ack_dt
string
ack_no
string
irn
string
signed_invoice
string
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes.
error_details
array of object (EInvoiceErrorDetails)
Show
error_code
string
Represents an identifier for the specific error encountered during the e-invoice generation or processing. This code facilitates quick identification and troubleshooting of issues, allowing for more efficient resolution.
error_message
string
Examples
Parameters
body:
body
Response
Retry E-invoice
eInvoiceRetry
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
shipment_idquery
string
Unique identifier of a shipment on the platform.
awbquery
string
AWB number
page_noquery
integer
Page number for pagination.
page_sizequery
integer
Number of records per page for pagination.
GET
Response
200
Shipment Tracking fetched successfully
Hide
items
array of object (CourierPartnerTrackingDetails)
Show
awb
string
The Air Waybill (AWB) number associated with the shipment, used for tracking the parcel in transit.
dp_location
string
Nullable
The current geographic location of the courier partner.
dp_name
string
The name of the courier partner responsible for the shipment.
dp_status
string
The current status of the shipment as updated by the courier partner.
dp_status_updated_at
string
| date-time
The timestamp when the status was last updated by the courier partner.
estimated_delivery_date
string
| date-time
Nullable
The estimated date and time for delivery as provided by the courier partner.
id
integer
| int32
A unique identifier for the tracking history entry.
journey
string
Indicates the type of journey the shipment.
Enum
meta
object
A field to store additional metadata related to the courier partner's operations or the shipment.
operational_status
string
The operational status of the shipment.
promised_delivery_date
string
| date-time
Nullable
PThe promised date and time for delivery as provided by the courier partner.
remark
string
Nullable
Any additional remarks or comments from the courier partner regarding the shipment.
shipment_id
string
The unique identifier for the shipment.
page
object (PageDetails)
Show
current
integer
| int32
Nullable
Current page number
has_next
boolean
Nullable
if next page contains any result
has_previous
boolean
Nullable
if previous page contains any result
item_total
integer
| int32
Total count of the results present in the requested filter
size
integer
| int32
Nullable
Page size
type
string
Nullable
Type of the page
Enum
Examples
Parameters
Parameters are not required.
Response
Track shipment
trackShipment
Modify courier partner tracking details for a given shipment Id or AWB number
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
bodyrequestBody
object (CourierPartnerTrackingDetails)
Required
Hide
awb
string
Required
The Air Waybill (AWB) number associated with the shipment, used for tracking the parcel in transit.
dp_location
string
Nullable
The current geographic location of the courier partner.
dp_name
string
Required
The name of the courier partner responsible for the shipment.
dp_status
string
The current status of the shipment as updated by the courier partner.
dp_status_updated_at
string
| date-time
Required
The timestamp when the status was last updated by the courier partner.
estimated_delivery_date
string
| date-time
Nullable
The estimated date and time for delivery as provided by the courier partner.
id
integer
| int32
A unique identifier for the tracking history entry.
journey
string
Required
Indicates the type of journey the shipment.
Enum
meta
object
A field to store additional metadata related to the courier partner's operations or the shipment.
operational_status
string
The operational status of the shipment.
promised_delivery_date
string
| date-time
Nullable
PThe promised date and time for delivery as provided by the courier partner.
remark
string
Nullable
Any additional remarks or comments from the courier partner regarding the shipment.
shipment_id
string
Required
The unique identifier for the shipment.
Request body
awb
string
Required
The Air Waybill (AWB) number associated with the shipment, used for tracking the parcel in transit.
dp_location
string
Nullable
The current geographic location of the courier partner.
dp_name
string
Required
The name of the courier partner responsible for the shipment.
dp_status
string
The current status of the shipment as updated by the courier partner.
dp_status_updated_at
string
| date-time
Required
The timestamp when the status was last updated by the courier partner.
estimated_delivery_date
string
| date-time
Nullable
The estimated date and time for delivery as provided by the courier partner.
id
integer
| int32
A unique identifier for the tracking history entry.
journey
string
Required
Indicates the type of journey the shipment.
Enum
meta
object
A field to store additional metadata related to the courier partner's operations or the shipment.
operational_status
string
The operational status of the shipment.
promised_delivery_date
string
| date-time
Nullable
PThe promised date and time for delivery as provided by the courier partner.
remark
string
Nullable
Any additional remarks or comments from the courier partner regarding the shipment.
shipment_id
string
Required
The unique identifier for the shipment.
POST
Response
200
Shipment Tracking updated successfully
Hide
awb
string
The Air Waybill (AWB) number associated with the shipment, used for tracking the parcel in transit.
dp_location
string
Nullable
The current geographic location of the courier partner.
dp_name
string
The name of the courier partner responsible for the shipment.
dp_status
string
The current status of the shipment as updated by the courier partner.
dp_status_updated_at
string
| date-time
The timestamp when the status was last updated by the courier partner.
estimated_delivery_date
string
| date-time
Nullable
The estimated date and time for delivery as provided by the courier partner.
id
integer
| int32
A unique identifier for the tracking history entry.
journey
string
Indicates the type of journey the shipment.
Enum
meta
object
A field to store additional metadata related to the courier partner's operations or the shipment.
operational_status
string
The operational status of the shipment.
promised_delivery_date
string
| date-time
Nullable
PThe promised date and time for delivery as provided by the courier partner.
remark
string
Nullable
Any additional remarks or comments from the courier partner regarding the shipment.
shipment_id
string
The unique identifier for the shipment.
Examples
Parameters
Parameters are not required.
Response
Update shipment tracking
updateShipmentTracking
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
invoice_typepath
string
Required
mention the type of invoice id to generate
Enum
bodyrequestBody
object (GenerateInvoiceIDRequestSchema)
Required
Hide
shipment_ids
array of string
Required
List of shipment IDs for which invoice need to be generated.
Request body
shipment_ids
array of string
Required
List of shipment IDs for which invoice need to be generated.
POST
Response
200
NOTE success response can contains success and failed result as well
Hide
items
array of object (GenerateInvoiceIDResponseData)
Show
shipment_id
string
The unique identifier for the shipment associated with the invoice.
success
boolean
Indicates whether the API call was successful (true) or not (false).
invoice_id
string
Nullable
The generated invoice ID, or null if the generation failed.
error_message
boolean
Nullable
Provides a descriptive error message.
Examples
Parameters
company_id:
1
invoice_type:
"value"
body:
body
Response
Generate and attach invoice Id
generateInvoiceID
Retrieve all packages associated with a specific shipment. This endpoint supports both single-piece and multi-piece shipments.
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
shipment_idpath
string
Required
Unique identifier for the shipment whose packages are being retrieved.
GET
Response
200
400
Packages retrieved successfully.
Hide
Schema representing a successful response from package-related operations, containing the package data along with success status and optional message.
success
boolean
Indicates whether the API call was successful (true) or failed (false).
data
object (PackagesSchema)
Show
Schema representing a collection of packages associated with a shipment. Used for both creating/updating packages and retrieving package information.
packages
array of object (PackageSchema)
Array of packages to be created or updated for the shipment. At least two packages are required for MPS functionality.
Show
id
string
Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.
packaging_id
string
Nullable
Optional reference to a predefined packaging configuration or template used for creating physical packages.
name
string
Nullable
A human-readable name or label for the package, used for identification and organizational purposes.
size
string
Nullable
The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.
package_type
string
Nullable
The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).
length
number
| float
Nullable
The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
width
number
| float
Nullable
The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
height
number
| float
Nullable
The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
weight
number
| float
Nullable
The actual weight of the package in kilograms, including packaging materials and products.
error_rate
number
| float
Nullable
The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).
package_vol_weight
number
| float
Nullable
The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.
max_weight
number
| float
Nullable
The maximum weight capacity that this package can handle, used for validation and logistics planning.
awb
string
Nullable
Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.
pdf_links
object
Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.
Default Value : [object Object]
products
array of object (PackageProduct)
List of products contained within this package. Each product specifies its line number, quantity, and identifier.
Show
line_number
integer
The line number of the product within the shipment, used for tracking and identification purposes.
quantity
number
The quantity of the product included in this package.
identifier
string
The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.
message
string
Nullable
A descriptive message providing additional information about the API response.
Response
Get shipment packages
getShipmentPackages
Create new packages for a shipment, enabling Multi-Piece Shipment (MPS) functionality. This operation validates courier partner availability and performs bag breaking as per number of packages. The system automatically validates MPS eligibility and store configuration before creating packages. If the store is not eligible for MPS, it will not let the user create packages.
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
shipment_idpath
string
Required
Unique identifier of the shipment.
bodyrequestBody
object (PackagesSchema)
Required
Hide
Schema representing a collection of packages associated with a shipment. Used for both creating/updating packages and retrieving package information.
packages
array of object (PackageSchema)
Required
Array of packages to be created or updated for the shipment. At least two packages are required for MPS functionality.
Show
id
string
Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.
packaging_id
string
Nullable
Optional reference to a predefined packaging configuration or template used for creating physical packages.
name
string
Nullable
A human-readable name or label for the package, used for identification and organizational purposes.
size
string
Nullable
The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.
package_type
string
Nullable
The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).
length
number
| float
Nullable
The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
width
number
| float
Nullable
The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
height
number
| float
Nullable
The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
weight
number
| float
Nullable
The actual weight of the package in kilograms, including packaging materials and products.
error_rate
number
| float
Nullable
The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).
package_vol_weight
number
| float
Nullable
The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.
max_weight
number
| float
Nullable
The maximum weight capacity that this package can handle, used for validation and logistics planning.
awb
string
Nullable
Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.
pdf_links
object
Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.
Default Value : [object Object]
products
array of object (PackageProduct)
List of products contained within this package. Each product specifies its line number, quantity, and identifier.
Show
line_number
integer
Required
The line number of the product within the shipment, used for tracking and identification purposes.
quantity
number
Required
The quantity of the product included in this package.
identifier
string
Required
The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.
Request body
packages
array of object (PackageSchema)
Required
Array of packages to be created or updated for the shipment. At least two packages are required for MPS functionality.
Show
id
string
Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.
packaging_id
string
Nullable
Optional reference to a predefined packaging configuration or template used for creating physical packages.
name
string
Nullable
A human-readable name or label for the package, used for identification and organizational purposes.
size
string
Nullable
The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.
package_type
string
Nullable
The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).
length
number
| float
Nullable
The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
width
number
| float
Nullable
The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
height
number
| float
Nullable
The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
weight
number
| float
Nullable
The actual weight of the package in kilograms, including packaging materials and products.
error_rate
number
| float
Nullable
The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).
package_vol_weight
number
| float
Nullable
The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.
max_weight
number
| float
Nullable
The maximum weight capacity that this package can handle, used for validation and logistics planning.
awb
string
Nullable
Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.
pdf_links
object
Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.
Default Value : [object Object]
products
array of object (PackageProduct)
List of products contained within this package. Each product specifies its line number, quantity, and identifier.
Show
line_number
integer
Required
The line number of the product within the shipment, used for tracking and identification purposes.
quantity
number
Required
The quantity of the product included in this package.
identifier
string
Required
The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.
POST
Response
201
400
Packages created successfully.
Hide
success
boolean
Indicates whether the API call was successful (true) or not (false).
message
string
A descriptive message providing additional information about the API response.
Response
Create shipment packages
createShipmentPackages
Update existing packages for a shipment. This operation replaces all existing packages with the provided package list. The system validates courier partner availability and performs bag breaking as per number of packages. Any packages without IDs will have new unique IDs generated.
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
shipment_idpath
string
Required
Unique identifier for the shipment whose packages will be updated.
bodyrequestBody
object (PackagesSchema)
Required
Hide
Schema representing a collection of packages associated with a shipment. Used for both creating/updating packages and retrieving package information.
packages
array of object (PackageSchema)
Required
Array of packages to be created or updated for the shipment. At least two packages are required for MPS functionality.
Show
id
string
Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.
packaging_id
string
Nullable
Optional reference to a predefined packaging configuration or template used for creating physical packages.
name
string
Nullable
A human-readable name or label for the package, used for identification and organizational purposes.
size
string
Nullable
The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.
package_type
string
Nullable
The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).
length
number
| float
Nullable
The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
width
number
| float
Nullable
The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
height
number
| float
Nullable
The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
weight
number
| float
Nullable
The actual weight of the package in kilograms, including packaging materials and products.
error_rate
number
| float
Nullable
The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).
package_vol_weight
number
| float
Nullable
The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.
max_weight
number
| float
Nullable
The maximum weight capacity that this package can handle, used for validation and logistics planning.
awb
string
Nullable
Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.
pdf_links
object
Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.
Default Value : [object Object]
products
array of object (PackageProduct)
List of products contained within this package. Each product specifies its line number, quantity, and identifier.
Show
line_number
integer
Required
The line number of the product within the shipment, used for tracking and identification purposes.
quantity
number
Required
The quantity of the product included in this package.
identifier
string
Required
The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.
Request body
packages
array of object (PackageSchema)
Required
Array of packages to be created or updated for the shipment. At least two packages are required for MPS functionality.
Show
id
string
Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.
packaging_id
string
Nullable
Optional reference to a predefined packaging configuration or template used for creating physical packages.
name
string
Nullable
A human-readable name or label for the package, used for identification and organizational purposes.
size
string
Nullable
The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.
package_type
string
Nullable
The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).
length
number
| float
Nullable
The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
width
number
| float
Nullable
The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
height
number
| float
Nullable
The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
weight
number
| float
Nullable
The actual weight of the package in kilograms, including packaging materials and products.
error_rate
number
| float
Nullable
The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).
package_vol_weight
number
| float
Nullable
The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.
max_weight
number
| float
Nullable
The maximum weight capacity that this package can handle, used for validation and logistics planning.
awb
string
Nullable
Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.
pdf_links
object
Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.
Default Value : [object Object]
products
array of object (PackageProduct)
List of products contained within this package. Each product specifies its line number, quantity, and identifier.
Show
line_number
integer
Required
The line number of the product within the shipment, used for tracking and identification purposes.
quantity
number
Required
The quantity of the product included in this package.
identifier
string
Required
The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.
PUT
Response
200
400
Packages updated successfully.
Hide
success
boolean
Indicates whether the API call was successful (true) or not (false).
message
string
A descriptive message providing additional information about the API response.
Response
Update shipment packages
updateShipmentPackages
Use this API to manually assign a courier partner (delivery partner) to a shipment.
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
shipment_idpath
string
Required
The unique identifier for the shipment. This ID is used to track and reference the shipment throughout its journey.
bodyrequestBody
object (ShipmentCourierPartnerRequestSchema)
Required
Hide
scheme_id
string
Required
Unique identifier for the courier partner scheme, used to fetch or modify scheme-specific details for the selected courier partner.
courier_partner_name
string
Required
The name of the courier partner selected by the user while manually assigning the delivery partner for the shipment.
extension_id
string
Required
Unique identifier of the courier partner extension configured in the logistics system. This is used to identify the courier partner to be assigned.
remarks
string
Optional remarks or additional comments provided by the user while manually assigning the courier partner.
tat
object (TATSchema)
Required
Show
A turn around time for the delivery partner to fulfill the order.
min
integer
Required
Specifies the minimum delivery promise timestamp (in UNIX epoch), indicating the earliest time delivery can be completed.
max
integer
Required
Specifies the maximum delivery promise timestamp (in UNIX epoch), indicating the latest time by which delivery is expected to be completed.
Request body
scheme_id
string
Required
Unique identifier for the courier partner scheme, used to fetch or modify scheme-specific details for the selected courier partner.
courier_partner_name
string
Required
The name of the courier partner selected by the user while manually assigning the delivery partner for the shipment.
extension_id
string
Required
Unique identifier of the courier partner extension configured in the logistics system. This is used to identify the courier partner to be assigned.
remarks
string
Optional remarks or additional comments provided by the user while manually assigning the courier partner.
tat
object (TATSchema)
Required
Show
A turn around time for the delivery partner to fulfill the order.
min
integer
Required
Specifies the minimum delivery promise timestamp (in UNIX epoch), indicating the earliest time delivery can be completed.
max
integer
Required
Specifies the maximum delivery promise timestamp (in UNIX epoch), indicating the latest time by which delivery is expected to be completed.
POST
Response
200
400
Successfully created a manual courier partner request for the shipment.
Hide
Standard response object returned after creating a manual courier partner request or saving a courier partner preference for a shipment.
message
string
A human-readable message describing the outcome of the operation.
Response
Manually request a courier partner for a shipment.
requestCourierPartnerForShipment
Use this API to save the preferred courier partner for a shipment. The preferred courier partner will be triggered automatically when the shipment moves to a state where delivery partner assignment is performed (for example, ready for DP assignment).
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
shipment_idpath
string
Required
The unique identifier for the shipment. This ID is used to track and reference the shipment throughout its journey.
bodyrequestBody
object (ShipmentCourierPartnerPreference)
Required
Hide
scheme_id
string
Required
Unique identifier for the courier partner scheme, used to fetch or modify scheme-specific details for the selected courier partner.
courier_partner_name
string
Required
The human-readable name of the courier partner that should be preferred when assigning a delivery partner for the shipment.
extension_id
string
Required
Unique identifier of the courier partner extension configured in the logistics system. This is used to identify the courier partner whose preference is saved.
remarks
string
Optional remarks or additional comments provided by the user while saving the courier partner preference.
tat
object (TATSchema)
Required
Show
A turn around time for the delivery partner to fulfill the order.
min
integer
Required
Specifies the minimum delivery promise timestamp (in UNIX epoch), indicating the earliest time delivery can be completed.
max
integer
Required
Specifies the maximum delivery promise timestamp (in UNIX epoch), indicating the latest time by which delivery is expected to be completed.
Request body
scheme_id
string
Required
Unique identifier for the courier partner scheme, used to fetch or modify scheme-specific details for the selected courier partner.
courier_partner_name
string
Required
The human-readable name of the courier partner that should be preferred when assigning a delivery partner for the shipment.
extension_id
string
Required
Unique identifier of the courier partner extension configured in the logistics system. This is used to identify the courier partner whose preference is saved.
remarks
string
Optional remarks or additional comments provided by the user while saving the courier partner preference.
tat
object (TATSchema)
Required
Show
A turn around time for the delivery partner to fulfill the order.
min
integer
Required
Specifies the minimum delivery promise timestamp (in UNIX epoch), indicating the earliest time delivery can be completed.
max
integer
Required
Specifies the maximum delivery promise timestamp (in UNIX epoch), indicating the latest time by which delivery is expected to be completed.
POST
Response
200
400
Successfully saved the courier partner preference for the shipment.
Hide
Standard response object returned after creating a manual courier partner request or saving a courier partner preference for a shipment.
message
string
A human-readable message describing the outcome of the operation.
Examples
Parameters
body:
body
Response
Save courier partner preference for a shipment.
saveCourierPartnerPreferenceForShipment
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
lanequery
string
Name of lane for which data is to be fetched
Enum
bag_statusquery
string
Comma separated values of bag statuses.
status_assignedquery
string
Used to filter shipments based on status present in shipment_status_history. For more information on these statuses, refer to the Fynd Partners documentation.
status_override_lanequery
boolean
Use this flag to fetch by bag_status and override lane.
Default Value : false
time_to_dispatchquery
integer
Indicates the time to dispatch.
Enum
search_typequery
string
Specifies the key used to determine the type of search being performed.
Enum
search_valuequery
string
The value corresponding to the search type, such as a specific shipment ID or order ID.
from_datequery
string
| date
Start Date in DD-MM-YYYY format
to_datequery
string
| date
End Date in DD-MM-YYYY format
start_datequery
string
| date-time
The UTC start date in ISO format (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
end_datequery
string
| date-time
The UTC end date in ISO format (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
status_assigned_start_datequery
string
| date-time
Specifies the starting UTC date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower boundary for filtering shipments based on the `created_at` timestamp of statuses in the shipment's status history. It allows filtering statuses that were created within a specific time range.
status_assigned_end_datequery
string
| date-time
Specifies the ending UTC date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary for filtering shipments based on the `created_at` timestamp of statuses in the shipment's status history.
dp_idsquery
string
A comma-separated list of delivery partner IDs to filter results by specific delivery partners.
storesquery
string
A comma-separated list of store IDs used to filter results to only those related to specific stores.
sales_channelsquery
string
A comma-separated list of sales channel IDs to filter results based on the sales channels involved.
page_noquery
integer
Specifies the page number for paginated results.
Default Value : 1
page_sizequery
integer
Determines the number of results returned per page.
Default Value : 10
fetch_active_shipmentquery
boolean
A boolean flag that indicates whether to include only active shipments in the results.
Default Value : true
allow_inactivequery
boolean
A flag indicating whether to allow the inclusion of inactive shipments in the results.
Default Value : false
exclude_locked_shipmentsquery
boolean
A flag to specify whether to exclude shipments that are locked from the results.
Default Value : true
payment_methodsquery
string
A comma-separated list of payment methods.
channel_shipment_idquery
string
The shipment ID used in the application, which can be used to reference specific shipments.
channel_order_idquery
string
The order ID used in the application.
custom_metaquery
string
Custom metadata associated with the query, allowing for additional filtering or information to be passed.
ordering_channelquery
string
The channel through which the order was placed.
company_affiliate_tagquery
string
A tag used to identify the company's affiliation for filtering or reporting purposes.
my_ordersquery
boolean
A boolean flag indicating whether the query should return only the user's orders.
platform_user_idquery
string
The unique identifier of the user on the platform, useful for filtering orders related to a specific user.
sort_typequery
string
Determines the sorting order of the results based on specific criteria.
Default Value : sla_asc
Enum
show_cross_company_dataquery
boolean
A flag indicating whether to include data from both cross-company and non-cross-company orders in the results.
Default Value : false
tagsquery
string
A comma-separated list of tags associated with the orders to filter results based on specific characteristics.
customer_idquery
string
The unique identifier for the customer associated with the query, useful for filtering results to a specific customer.
order_typequery
string
The type of order being queried.
Enum
group_entityquery
string
Defines the grouping criterion for retrieving shipments or orders. It specifies whether the results should be organized based on shipment groups or order groups. For example, using 'shipments' groups results by shipment, while an invalid value like 'abcd' may not be recognized, leading to errors or default behavior.
enforce_date_filterquery
boolean
Applies a date filter for listing shipments. This is useful when fetching data for a specific date range while performing searches.
Default Value : false
fulfillment_typequery
string
Define the Fulfillment Type for Listing Orders, This is use when we want to get list of shipments or orders by cross store or cross company or fulfilling Store (by default), this is also depends on the login user accessType and store access
Enum
ordering_sourcequery
string
Filter orders by ordering source. Accepts comma-separated values for multiple sources.
channel_account_idquery
string
Comma-separated channel account IDs to filter orders by specific channel accounts.
GET
Response
200
We are processing the report!
Hide
total_count
integer
Nullable
The total number of shipments matching the query criteria.
message
string
Nullable
A message providing additional context about the response.
success
boolean
Nullable
Indicates whether the API call was successful (true) or not (false).
items
array of object (ShipmentItem)
An array of shipment items returned as part of the response.
Show
order_date
string
| date-time
Nullable
Denotes the date and time when an order was placed by the customer. This timestamp is crucial for tracking the order'
order_created_ts
string
| date-time
Nullable
The timestamp indicating when the order was created in UTC format.
ordering_source_details
object (OrderingSourceDetails)
Show
type
string
Type of the ordering source.
Enum
slug
string
Slug identifier of the ordering source.
display_name
string
Display name of the ordering source.
is_active
boolean
Indicates whether the ordering source is active.
logo
string
| uri
Logo URL of the ordering source.
shipment_status
object (ShipmentStatus)
Show
current_shipment_status
string
Nullable
The current status of the shipment.
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
id
integer
Nullable
A unique identifier for the shipment status.
bag_list
array of string
Nullable
A list of bags associated with the shipment, useful for tracking individual items within the shipment.
title
string
A brief title or label for the shipment status, summarizing its current state.
display_name
string
A user-friendly name or identifier for the shipment status.
created_at
string
| date-time
Nullable
Timestamp when the shipment was initially created.This timestamp is crucial for tracking the shipment's age, scheduling, and historical analysis.
created_ts
string
Nullable
A general timestamp for when the shipment was created, formatted for internal processing.
shipment_id
string
Nullable
A unique identifier for the shipment.
status_created_at
string
| date-time
Nullable
Timestamp when the transition for the status of the shipment was created. Date time in UTC timezone as per ISO format.
updated_ts
string
Nullable
A general timestamp indicating when the status was updated, useful for processing and tracking.
status
string
This key denotes the status of the shipment, providing a clear indication of its current processing stage.
user
object (UserDataInfo)
Show
Contains the details of the user who created the order including identifying information and relevant metadata.
id
integer
Nullable
The unique identifier associated with the user.
user_oid
string
Nullable
The object ID for the user, used for referencing the user in various operations.
mongo_user_id
string
Nullable
The identifier for the user.
external_customer_id
string
Nullable
The identifier for the user in external systems.
first_name
string
Nullable
The first name of the user.
last_name
string
Nullable
The last name of the user.
mobile
string
Nullable
The mobile phone number of the user.
email
string
Nullable
The email address of the user.
meta
object
Nullable
Additional metadata related to the user.
is_anonymous_user
boolean
Nullable
Indicates whether the user is an anonymous user (true) or registered (false).
name
string
Nullable
A full name of the user, which may be a combination of first and last name.
gender
string
Nullable
The gender of the user.
country_phone_code
string
The country-specific phone code, useful for formatting mobile numbers correctly.
estimated_sla_time
string
Nullable
The estimated Service Level Agreement (SLA) time for the shipment.
estimated_sla_ts
string
Nullable
The timestamp for the estimated SLA, providing a specific time for expected delivery in UTC format.
delivery_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
billing_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
affiliate_details
object (AffiliateDetails)
Show
Details of an affiliate associated with a shipment.
shipment_meta
object (ShipmentMeta)
Show
tracking_url
string
Nullable
A URL for tracking the shipment.
estimated_delivery_date
string
| date-time
Nullable
Provides a forecasted date and time by which the shipment is expected to be delivered to the recipient. This estimation is crucial for planning purposes, both for the sender in managing expectations and for the recipient in preparing for receipt.
same_store_available
boolean
Indicates whether the shipment is available for pickup from the same store.
b2b_buyer_details
object (BuyerDetails)
Show
ajio_site_id
string
Nullable
The unique identifier for the buyer on the Ajio platform.
pincode
integer
The postal code for the buyer's shipping address, used for delivery location identification.
address
string
Provides the comprehensive address details of the buyer's shipping address.
gstin
string
The Goods and Services Tax Identification Number (GSTIN) of the buyer.
name
string
The full name of the buyer, essential for personalizing communication and delivery.
state
string
The name of the state where the buyer's shipping address is located, important for logistical purposes.
city
string
The name of the city where the buyer's shipping address is located, which helps in identifying delivery zones.
formatted
object (Formatted)
Show
max
string
Nullable
Represents the maximum formatted value, providing a limit for the associated data, such as dimensions or weights.
min
string
Nullable
Represents the minimum formatted value, establishing a lower limit for the associated data, ensuring it meets certain criteria or standards.
debug_info
object (DebugInfo)
Show
stormbreaker_uuid
string
Nullable
A unique identifier (UUID) associated with the Stormbreaker system, used for tracking and debugging purposes in the application.
return_awb_number
string
Nullable
The Air Waybill (AWB) number associated with a return shipment.
is_self_ship
boolean
Nullable
Indicates whether the shipment is a self-shipped order.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
einvoice_info
object (EinvoiceInfo)
Show
credit_note
object
Nullable
Specifies the reverse einvoice transaction create on government portal.
invoice
object
Nullable
It specifies the forward einvoice transaction created on government portal.
return_affiliate_shipment_id
string
Nullable
The shipment ID associated with a return from an affiliate.
parent_dp_id
string
Nullable
The unique identifier for the parent delivery partner.
shipment_weight
number
Nullable
The total weight of the shipment.
dimension
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment.
assign_dp_from_sb
boolean
Nullable
Indicates whether to assign the delivery partner from the store’s basket.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
store_invoice_updated_date
string
| date-time
Nullable
Denotes the date and time when the store's invoice related to this shipment was updated. This timestamp is vital for tracking changes to billing details, adjustments in charges, or updates in the invoicing status.
forward_affiliate_shipment_id
string
Nullable
The shipment ID for the forward journey of an affiliate shipment.
return_store_node
integer
Nullable
The identifier for the store node involved in the return process.
fulfilment_priority_text
string
Nullable
Textual representation of the fulfillment priority for the shipment.
shipment_tags
array of object (ShipmentTags)
Tags associated with the shipment for categorization and filtering.
Show
slug
string
Nullable
A URL-friendly string representing the tag, often used for routing or categorization.
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
display_text
string
Nullable
A human-readable text representation of the tag, used for display purposes in user interfaces.
external
object
Nullable
External metadata related to the shipment.
awb_number
string
Nullable
The Air Waybill number associated with the shipment.
lock_data
object (LockData)
Show
locked
boolean
Nullable
Indicates whether the shipment is currently locked for processing (true) or not (false).
mto
boolean
Nullable
A flag indicating whether the shipment is part of a multi-modal transport operation.
lock_message
string
Nullable
An optional message providing additional context or information regarding the lock status.
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.
Enum
ewaybill_info
object
Nullable
Electronic Way Bill details i.e ewayBillNo, ewayBillDate that are utilized in the transportation of goods.
dp_id
string
Nullable
The unique identifier for the delivery partner associated with the shipment.
shipment_volumetric_weight
number
Nullable
The volumetric weight of the shipment, which may differ from its actual weight.
marketplace_store_id
string
Nullable
The unique identifier for the marketplace store associated with the shipment.
return_details
object
Nullable
An object containing the return details of the shipment.
dp_sort_key
string
Nullable
A sort key for the delivery partner, used for prioritization.
packaging_name
string
Nullable
The name of the packaging used for the shipment.
timestamp
object (ShipmentTimeStamp)
Show
max
integer
Nullable
Represents the maximum timestamp value, indicating the latest time relevant to the shipment.
min
integer
Nullable
Represents the minimum timestamp value, indicating the earliest time relevant to the shipment.
auto_trigger_dp_assignment_acf
boolean
Nullable
Indicates whether automatic delivery partner assignment is triggered for this shipment.
dp_name
string
Nullable
The name of the delivery partner associated with the shipment.
po_number
string
Nullable
The purchase order number associated with the shipment.
weight
integer
The weight of the shipment, typically measured in grams or kilograms.
b2c_buyer_details
object
Nullable
Contains detailed information about the buyer in a business-to-consumer (B2C) transaction. This object is designed to capture a wide array of buyer-specific data such as contact information, shipping address, preferences, and any other relevant details that enhance the understanding of the buyer's profile and needs.
forward_affiliate_order_id
string
Nullable
The order ID for the forward journey of an affiliate shipment.
return_affiliate_order_id
string
Nullable
The order ID for the return journey of an affiliate shipment.
bag_weight
object
Nullable
This object is designed to accommodate a range of weight-related information. Denotes the weight of the bag, potentially including various measurements or related details.
refund_to
string
Nullable
Specifies the recipient of any refunds related to the shipment.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_shipment_id
string
The shipment ID specific to this affiliate.
company_affiliate_tag
string
Nullable
An optional tag representing the company's affiliate association.
affiliate_order_id
string
The order ID associated with the affiliate shipment.
pdf_links
object (PDFLinks)
Show
invoice_type
string
The type of invoice issued, such as 'fynd' or other classifications.
Enum
label_a6
string
Nullable
URL or path to the A6 size label document.
invoice
string
Nullable
URL or path to the main invoice document.
label_pos
string
Nullable
URL or path to the POS label document.
invoice_a6
string
Nullable
URL or path to the A6 size invoice document.
b2b
string
Nullable
URL or path to the B2B document related to the transaction.
label
string
Nullable
URL or path to the general label document.
label_a4
string
Nullable
URL or path to the A4 size label document.
label_type
string
Specifies the type of label associated with a PDF document,indicating its purpose or content. The label_type helps in organizing and identifying PDF documents quickly, ensuring that users or systems can efficiently utilize the correct documents for required actions.
Enum
invoice_export
string
Nullable
URL or path to the exported invoice document.
credit_note_url
string
Nullable
URL or path to the credit note document.
delivery_challan_a4
string
Nullable
URL or path to the A4 delivery challan document.
label_export
string
Nullable
URL or path to the exported label document.
invoice_a4
string
Nullable
URL or path to the A4 size invoice document.
invoice_pos
string
Nullable
URL or path to the POS invoice document.
po_invoice
string
Nullable
URL or path to the purchase order invoice document.
config
object (AffiliateConfig)
Show
app
object (AffiliateAppConfig)
Show
id
string
description
string
updated_at
string
| date-time
The date and time when the app config was updated.
name
string
token
string
meta
array of object (AffiliateAppConfigMeta)
Show
value
string
name
string
owner
string
secret
string
created_at
string
| date-time
Timestamp when the app config was created.
inventory
object (AffiliateInventoryConfig)
Show
article_assignment
object (AffiliateInventoryArticleAssignmentConfig)
Show
post_order_reassignment
boolean
payment
object (AffiliateInventoryPaymentConfig)
Show
source
string
mode_of_payment
string
inventory
object (AffiliateInventoryStoreConfig)
Show
store
object
Fulfilling store information related to the shipment.
order
object (AffiliateInventoryOrderConfig)
Show
force_reassignment
boolean
logistics
object (AffiliateInventoryLogisticsConfig)
Show
dp_assignment
boolean
app_company_id
integer
Nullable
A unique identifier for the company associated with the affiliate app, used for tracking and managing affiliate relationships.
affiliate_id
string
Nullable
The unique identifier for the affiliate.
affiliate_store_id
string
The unique identifier for the affiliate's store.
affiliate_bag_id
string
The unique identifier for the affiliate's bag.
id
string
Nullable
The unique identifier for the affiliate.
is_active
boolean
This flag denotes whether the shipment is active or not.
channel
object (ShipmentListingChannel)
Show
channel_shipment_id
string
Nullable
A unique identifier for the shipment associated with a specific channel, facilitating tracking and management.
is_affiliate
boolean
Nullable
Indicates whether the shipment is associated with an affiliate program, which may affect processing and fulfillment.
logo
string
Nullable
A URL or path to the logo of the shipment channel, used for branding and identification purposes.
name
string
Nullable
The name of the shipment channel, providing a human-readable reference for the channel through which the shipment is processed.
previous_shipment_id
string
Nullable
The ID of any previous shipment related to this order.
forward_end_shipment_id
string
Nullable
The forward_end_shipment_id represents the shipment ID of the original forward journey shipment. When a shipment is transitioned to a return journey, the original shipment ID from the forward journey is recorded in the forward_end_shipment_id field of the return journey shipment. Even if the return shipment is later split into multiple shipments, each of these shipments will retain the same forward_end_shipment_id value that was assigned during the initial return journey initiation. This ensures that all return shipments can be traced back to the original forward journey shipment.
lock_status
boolean
Nullable
Indicates whether the shipment is currently locked for processing (true) or not (false).
invoice_id
string
Nullable
The ID of the invoice associated with the shipment.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. This includes metadata such as logos, payment IDs, and merchant codes, as well as transaction-specific details like the payment mode, name, amount, and entities responsible for refunds and collections. The structure is designed to accommodate any number of payment methods, providing flexibility and comprehensive insights into each transaction's payment aspect.
payment_info
array of object
Nullable
An array of payment information items related to the shipment, detailing transaction specifics.
status_created_at
string
| date-time
Date time in UTC timezone as per ISO format.
status_created_ts
string
The timestamp indicating when the current status was logged, usually in ISO 8601 format.
display_name
string
Nullable
A user-friendly name or identifier for the shipment, useful for display purposes.
bags
array of object (BagUnit)
An array of bags included in the shipment.
Show
bag_type
string
Nullable
Specifies the type or category of the bag.
Enum
gst
object (GSTDetailsData)
Show
cgst_tax_percentage
number
Nullable
The percentage of Central Goods and Services Tax (CGST) applicable on the goods or services.
gstin_code
string
Nullable
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.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
gst_fee
number
The total GST fee charged on the goods or services.
igst_tax_percentage
number
Nullable
The percentage of Integrated Goods and Services Tax (IGST) applicable for inter-state transactions.
gst_tax_percentage
number
Nullable
The overall GST tax percentage applicable to the goods or services.
hsn_code_id
string
Nullable
Unique identifier for the Harmonized System of Nomenclature (HSN) code used to classify goods.
igst_gst_fee
number
Nullable
The GST fee applicable for IGST, usually for inter-state transactions.
is_default_hsn_code
boolean
Nullable
Indicates whether this HSN code is the default classification for the goods.
sgst_gst_fee
number
Nullable
The GST fee applicable for State Goods and Services Tax (SGST).
tax_collected_at_source
number
Tax amount collected at the source of income or transaction, often for compliance and revenue tracking.
brand_calculated_amount
number
Amount calculated by the brand, potentially reflecting costs, fees, or pricing structures.
cgst_gst_fee
number
Nullable
The GST fee applicable for CGST.
gst_tag
string
Nullable
A tag or label used to denote GST-related attributes or classifications.
sgst_tax_percentage
number
Nullable
The percentage of State Goods and Services Tax (SGST) applicable on the goods or services.
hsn_code
string
Nullable
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.
financial_breakup
array of object (FinancialBreakup)
Show
refund_credit
number
The amount of refund credits applicable for the transaction.
amount_paid_roundoff
integer
Nullable
Total amount paid, rounded off to the nearest integer for billing purposes.
price_effective
number
The effective price after applying discounts and before any taxes.
promotion_effective_discount
number
The amount of discount applied from promotional offers.
transfer_price
number
The fixed selling price applicable for payouts by the brand.
coupon_effective_discount
number
The discount applied through a coupon code, if applicable.
gst_fee
number
Total Goods and Services Tax (GST) fee charged on the goods or services.
tax_collected_at_source
number
Nullable
Tax amount collected at the source of income or transaction.
brand_calculated_amount
number
Amount calculated by the brand, possibly reflecting various costs or fees.
delivery_charge
number
Fee applicable for the delivery of the goods.
gst_tag
string
A tag used to denote GST-related attributes or classifications.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods, used in trade and commerce for uniform identification across different countries.
cashback
number
The cashback amount provided to the customer, if applicable.
item_name
string
The name or description of the item related to the financial breakup.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
cashback_applied
number
The effective cashback value that has been applied to the transaction.
cod_charges
number
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
The indicated price or value assigned to an item before any discounts or adjustments.
size
string
The size of the item, if applicable.
amount_paid
number
Total amount paid by the customer for the transaction.
coupon_value
number
The effective value of the coupon used in the transaction.
discount
number
Total amount discounted from the original price of the goods.
fynd_credits
number
Credits provided by Fynd to the customer, possibly as part of a rewards program.
gst_tax_percentage
number
The percentage of GST applicable on the goods or services.
amount_to_be_collected
number
Amount to be collected in case of multiple modes of payments.
identifiers
object (Identifier)
Show
alu
string
Nullable
The ALU (Article Level Unit) code used to identify the item at a detailed level, often specific to certain retail or distribution systems.
ean
string
Nullable
The European Article Number (EAN) is a unique identifier for products, primarily used in retail and logistics. It helps in tracking and managing inventory across various platforms.
sku_code
string
Nullable
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.
upc
string
Nullable
The Universal Product Code (UPC) is a barcode symbol used for tracking trade items in stores. It is widely used in North America and helps in identifying products quickly during point-of-sale transactions.
isbn
string
Nullable
The International Standard Book Number (ISBN) is a unique identifier for books, allowing for easier management and tracking of book inventories in retail and library systems.
total_units
integer
The total number of units involved in the transaction.
added_to_fynd_cash
boolean
Indicates whether the amount has been added to Fynd cash for future use.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Represents a detailed breakdown of a specific tax component applied to a transaction or item.
This schema provides information about the type of tax, the rate at which it is applied,
the calculated tax amount, and the base amount on which the tax is computed.
name
string
The name or type of the tax component (e.g., GST, VAT, Service Tax).
This helps in identifying the specific tax being applied to the transaction or item.
rate
number
| float
The percentage rate at which the tax is applied to the taxable amount.
This value is typically represented as a decimal (e.g., 0.18 for 18% tax).
tax_amount
number
| float
The total monetary value of the tax calculated for this component.
This is derived by applying the tax rate to the taxable amount.
taxable_amount
number
| float
The base amount on which the tax is calculated, excluding the tax itself.
This represents the value of goods or services before tax is applied.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
bag_expiry_date
string
| date-time
Nullable
Indicates the date and time when the contents of a bag, or the bag itself, are no longer considered valid or safe for use. This is particularly relevant in contexts where the bag contains perishable goods, sensitive materials, or items with a limited shelf life
bag_status
array of object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
current_operational_status
object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
article
object (Article)
Show
seller_identifier
string
Unique identifier assigned by the seller to the article, used for inventory management.
uid
string
A unique identifier for the article within the system.
set
object
Nullable
Represents the data related to combinations of articles that, while being the same product, vary by size, color, or other distinguishing features.
dimensions
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
currency
object
Nullable
Currency in which the transaction amount associated with the article is specified.
esp_modified
boolean
Nullable
Indicates whether the article has been modified by the ESP (e-commerce service provider).
return_config
object (ReturnConfig)
Nullable
Configuration related to the return policy for the article.
Show
returnable
boolean
Nullable
Indicates whether the article is eligible for return, allowing customers to send it back under specified conditions.
time
number
Nullable
The time frame within which the return must be initiated, typically measured in days.
unit
string
Nullable
The unit of time for the return period (e.g., days, weeks).
code
string
Nullable
Internal code or identifier for the article, used for reference.
weight
object (Weight)
Show
is_default
boolean
Nullable
Indicates whether this weight value is the default weight used for the article.
shipping
integer
Nullable
The weight of the article specifically for shipping purposes, usually measured in grams or kilograms.
unit
string
Nullable
The unit of measurement for the weight (e.g., grams, kilograms, pounds).
_id
string
The unique identifier for the article within the database.
identifiers
object
Details of identifiers associated with the article, including SKU codes and other relevant identifiers.
raw_meta
string
Nullable
Raw metadata associated with the article, providing additional context or information.
size
string
Size of the article, which may vary for clothing, accessories, etc.
is_set
boolean
Nullable
Indicates whether the article is part of a set or collection.
tags
array of string
Nullable
Tags associated with the article for categorization and search optimization.
_custom_json
object
A custom JSON object containing additional details or configurations specific to the article.
brand
object (ShipmentListingBrand)
Show
logo
string
Nullable
URL or path to the logo image of the brand associated with the shipment.
created_on
string
| date-time
Nullable
Timestamp indicating when the brand of the shipment was created, formatted as date-time.
name
string
Nullable
The name of the brand linked to the shipment.
logo_base64
string
Nullable
Base64 encoded string of the brand's logo image, allowing for direct embedding in documents or applications.
affiliate_bag_details
object (AffiliateBagDetails)
Show
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_order_id
string
Unique identifier for the affiliate order associated with the bag.
employee_discount
number
Nullable
Discount percentage or amount applicable to employees for this order.
affiliate_bag_id
string
Unique identifier for the affiliate bag, used for tracking and reference.
loyalty_discount
number
| float
Discount amount applied based on customer loyalty, if applicable.
item
object (PlatformItem)
Show
id
integer
Nullable
Unique identifier for the platform item.
attributes
object (PlatformArticleAttributes)
Show
currency
string
Nullable
The currency in which the price of the article is specified.
brand_id
integer
Nullable
Identifier for the brand associated with the item.
slug_key
string
Nullable
A user-friendly string that represents the item, often used in URLs.
l3_category
integer
Nullable
Represents the product's classification at the third level in the e-commerce platform's category hierarchy, using an integer identifier.
l3_category_name
string
Nullable
Name of the third-level category under which the product is listed.
last_updated_at
string
| date-time
Nullable
Timestamp when any aspect of the associated record was modified, formatted as date-time.
name
string
Nullable
The name of the product item.
l2_category
array of string
Nullable
Represents the second level of categorization for items, helping customers narrow down their search.
brand
string
Nullable
Name of the brand associated with the item.
image
array of string
Nullable
Array of image URLs representing the item.
code
string
Nullable
Unique code for the item, often used for inventory management.
l1_category
array of string
Nullable
Represents the highest or top-tier level of categorization for the product.
size
string
Nullable
Size specification of the product, if applicable.
can_cancel
boolean
Nullable
Indicates whether the item can be canceled after order placement.
can_return
boolean
Nullable
Indicates whether the item is eligible for return.
branch_url
string
Nullable
URL linking to a specific branch or store where the item is available.
meta
object
Nullable
Meta data containing additional, dynamic information about the item.
color
string
Nullable
Color specification of the product, if applicable.
department_id
integer
Nullable
Identifier for the department associated with the product.
images
array of string
Nullable
Array of image URLs representing different views or angles of the item.
tags
array of string
Nullable
Custom labels or keywords associated with the item for categorization, filtering, or business logic purposes.
reasons
array of object
Nullable
A collection of reasons associated with the bag, which could pertain to returns, cancellations, or other relevant contexts.
product_quantity
integer
The total quantity of products contained within the bag.
can_return
boolean
Nullable
Indicates whether the items in the bag are eligible for return.
display_name
string
Nullable
A user-friendly name or label for the bag, which may be displayed in interfaces.
can_cancel
boolean
Nullable
Indicates whether the bag or its contents can be canceled.
size
string
Nullable
Specifies the size of the bag, which may be relevant for packaging or shipping considerations.
line_number
integer
Nullable
Represents the line number in an order or transaction associated with the bag.
meta
object
Nullable
Meta data of the bag contains additional, potentially dynamic information about the bag.
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
dates
object (Dates)
Show
delivery_date
string
| date-time
Nullable
Represents the scheduled date and time for the delivery of the entity.
order_created
string
Nullable
current_status
object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
bag_id
integer
Unique identifier for the bag.
entity_type
string
Nullable
Specifies the type of entity.
Enum
status
object (BagReturnableCancelableStatus)
Show
is_returnable
boolean
Indicates whether the bag can be returned by the customer.
is_active
boolean
Specifies if the current status of the bag is active, affecting its eligibility for return or cancellation.
can_be_cancelled
boolean
Indicates if the bag order can be cancelled by the customer.
enable_tracking
boolean
Indicates whether tracking is enabled for the bag, allowing customers to monitor its status.
is_customer_return_allowed
boolean
Specifies if the customer is permitted to return the bag, based on the return policy.
fulfilling_store
object (ShipmentItemFulFillingStore)
Show
phone
string
Nullable
Contact number for the fulfilling store, allowing customers to reach out for inquiries or assistance.
brand_store_tags
array of string
Nullable
Tags associated with the brand store, providing additional categorization or identification of the store's attributes.
pincode
string
Nullable
Postal code for the fulfilling store's location, essential for identifying the specific area and ensuring accurate deliveries.
meta
object
Nullable
Meta data of the fulfilling store that contains additional, potentially dynamic information about the fulfilling store.
address
string
Nullable
Comprehensive address details of the fulfilling store, including all necessary components for locating the store.
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
Address1 compiles all into a single formatted string.
The address is formed by the template provided and whichever keys are present in the template are
populated as is from store address fields.
Template Example: {address} {address2}_{area} {state}_{country},
display_address
string
Nullable
A user-friendly formatted version of the store's address for display purposes, making it easier for customers to read.
location_type
string
Nullable
Type of location of the fulfilling store.
Enum
id
integer
Unique identifier for the fulfilling store in the database.
code
string
A specific code assigned to the store, often used for internal tracking or categorization purposes.
store_email
string
Nullable
Email address for the fulfilling store, allowing for electronic communication and inquiries.
name
string
Nullable
The name of the fulfilling store, which helps customers identify the store.
state
string
Nullable
The state where the fulfilling store is located, important for regional identification.
city
string
Nullable
The city where the fulfilling store is situated, providing more specific location details.
tags
array of string
Nullable
Additional tags associated with the store, used for categorization and filtering purposes.
meta
object
Meta data of the item contains additional, potentially dynamic information about the item.
payment_mode
string
Nullable
The mode of payment used for the shipment.
can_process
boolean
Nullable
Indicates whether the shipment can currently be processed (true) or not (false).
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
order_id
string
The unique identifier of the order for the shipment.
ordering_channnel
string
Nullable
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
shipment_id
string
Nullable
The unique identifier for the shipment itself.
customer_note
string
Nullable
Any special notes or instructions provided by the customer related to the shipment.
total_bags
integer
The total number of bags in the shipment.
shipment_created_at
string
| date-time
Timestamp of the shipment created.
mode_of_payment
string
The method of payment used to create the order.
shipment_created_ts
string
The timestamp indicating when the shipment was created.
currency
object (Currency)
Show
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.
currency_symbol
string
The symbol representing the currency.
currency_info
object (CurrencyInfo)
Show
ordering_currency
object (OrderingCurrency)
Show
currency_code
string
This specifies the currency code for all amounts.
currency_name
string
The full name of the currency.
currency_symbol
string
The symbol representing the currency.
currency_sub_unit
string
The sub-unit of the currency
conversion_rate
object (ConversionRate)
Show
base
string
The base currency code, example 'INR' for Indian Rupee, against which all conversion rates are calculated. Follows the ISO 4217 standard.This includes the currency's name, its conversion rate relative to the base currency ('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency conversion but also enriches the data with useful currency descriptors, enhancing financial operations and analyses.
rates
object
An object , where each key is a currency code and its value is an object containing detailed information
about that currency. This includes the currency's name, its conversion rate relative to the base currency
('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency
conversion but also enriches the data with useful currency descriptors.
is_lapa_enabled
boolean
Flag to show NDR actions based on LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true, else false.
logistics_meta
object
An object storing detailed logistics-related information, including courier partner details and other relevant metadata.
fulfillment_option
object (FulfillmentOption)
Show
name
string
slug
string
type
string
is_default
boolean
lane
string
Nullable
The lane associated with the shipment.
page
object (Page)
Show
An object representing a page with pagination details.
item_total
integer
| int32
The total number of all items across all pages.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, can be 'cursor' or 'number'.
size
integer
| int32
The number of items per page.
page_size
integer
| int32
The number of items per page.
Response
List shipments
getShipments
Parameters
company_idpath
integer
Required
Unique identifier of a company on the platform.
channel_shipment_idquery
string
The shipment ID used in the application, which can be used to reference specific shipments.
shipment_idquery
string
The unique identifier for a shipment.
fetch_active_shipmentquery
boolean
flag to fetch active or deactivated shipments
allow_inactivequery
boolean
Flag indicating whether inactive shipments are allowed
Default Value : false
GET
Response
200
We are processing the report!
Hide
message
string
Nullable
A descriptive message providing additional information about the API response.
success
boolean
Indicates whether the API call was successful (true) or not (false).
shipments
array of object (PlatformShipment)
A list of platform shipment objects, containing information related to a shipment.
Show
fulfillment_option
object (FulfillmentOption)
Show
name
string
slug
string
type
string
is_default
boolean
picked_date
string
| date-time
Nullable
Indicates the date and time when the shipment was physically picked up from the sender or the origin point by the delivery service. This timestamp is crucial for tracking the commencement of the shipment's journey.
tracking_list
array of object (TrackingList)
A list of tracking updates associated with the shipment.
Show
is_passed
boolean
Nullable
A flag indicating whether the tracking event has already occurred. If true, it means the event is in the past; otherwise, it is either current or future.
text
string
A descriptive message or status update associated with the tracking event, providing context about the shipment's progress or condition.
is_current
boolean
Nullable
A flag indicating whether this tracking event is the most recent update. If true, it reflects the latest status of the shipment.
time
string
Nullable
A timestamp representing when the tracking event occurred. This helps in understanding the timeline of the shipment's journey.
created_ts
string
Nullable
A timestamp indicating when the tracking information was created or logged in the system. This may differ from the event time.
status
string
The specific status associated with the tracking event, such as "In Transit," "Delivered," or "Out for Delivery," providing clarity on the shipment's current phase.
invoice
object (InvoiceInfo)
Show
store_invoice_id
string
Nullable
A unique identifier for the invoice generated by the store or platform, used for internal tracking and reference.
invoice_url
string
Nullable
A URL linking to the digital version of the invoice, allowing users to view or download the invoice document online.
updated_date
string
| date-time
Nullable
Denotes the date and time when the invoice information was modified or updated, providing a record of the most recent changes.
external_invoice_id
string
Nullable
An identifier for the invoice used by external systems or partners, facilitating cross-system tracking and reconciliation.
label_url
string
Nullable
A URL linking to the shipping label associated with the invoice, which may be used for shipment tracking and logistics.
credit_note_id
string
Nullable
The identifier for any credit note related to the invoice, used in cases of refunds or adjustments to the original billing.
links
object
An object containing additional links relevant to the invoice, which may include related documents or resources.
shipment_status
string
Nullable
Represents the current status of the shipment.
gst_details
object (GSTDetailsData)
Show
cgst_tax_percentage
number
Nullable
The percentage of Central Goods and Services Tax (CGST) applicable on the goods or services.
gstin_code
string
Nullable
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.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
gst_fee
number
The total GST fee charged on the goods or services.
igst_tax_percentage
number
Nullable
The percentage of Integrated Goods and Services Tax (IGST) applicable for inter-state transactions.
gst_tax_percentage
number
Nullable
The overall GST tax percentage applicable to the goods or services.
hsn_code_id
string
Nullable
Unique identifier for the Harmonized System of Nomenclature (HSN) code used to classify goods.
igst_gst_fee
number
Nullable
The GST fee applicable for IGST, usually for inter-state transactions.
is_default_hsn_code
boolean
Nullable
Indicates whether this HSN code is the default classification for the goods.
sgst_gst_fee
number
Nullable
The GST fee applicable for State Goods and Services Tax (SGST).
tax_collected_at_source
number
Tax amount collected at the source of income or transaction, often for compliance and revenue tracking.
brand_calculated_amount
number
Amount calculated by the brand, potentially reflecting costs, fees, or pricing structures.
cgst_gst_fee
number
Nullable
The GST fee applicable for CGST.
gst_tag
string
Nullable
A tag or label used to denote GST-related attributes or classifications.
sgst_tax_percentage
number
Nullable
The percentage of State Goods and Services Tax (SGST) applicable on the goods or services.
hsn_code
string
Nullable
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.
order_status
object (OrderStatusData)
Show
Object that contains delivery status information, including a descriptive label, time information, color code for visual representation, and the expected delivery date.
order_details
object (OrderDetails)
Show
fynd_order_id
string
created_at
string
| date-time
Date and time when the order was created.
user_id
string
Nullable
tax_details
object (TaxDetails)
Show
pan_no
string
Nullable
gstin
string
Nullable
mongo_cart_id
number
Nullable
delivery_charges
number
Nullable
transaction_id
string
Nullable
collect_by
string
headers
object
Nullable
Header details of the order.
coupon_value
number
Nullable
order_value
number
created_time
string
currency
string
The currency in which the prices details associated with the item is specified.
total_order_value
number
ordering_channel
string
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
meta
object
Nullable
Meta data of the order data contains additional, potentially dynamic information about the order data.
cod_charges
number
Nullable
cashback_value
number
Nullable
refund_by
string
affiliate_order_date
string
| date-time
Nullable
Specifies the date and time of the order when it was created within the affiliate's system. It specifies that the date and time are recorded in ISO 8601 format.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. The structure is designed to accommodate any number of payment methods,providing flexibility and comprehensive insights into each transaction's payment aspect.
affiliate_order_id
string
payment_mode_id
number
Nullable
promotion_effective_discount
number
Nullable
mode_of_payment
string
discount
number
Nullable
cashback_applied
number
Nullable
fynd_credits
number
Nullable
affiliate_id
string
ordering_channel_logo
string
Nullable
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
loyalty_discount_details
object (LoyaltyDiscountDetails)
Show
Object containing detailed information about the loyalty discount applied during an order.
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed.
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace.
Enum
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order.
errors
array of string
A list of any errors that occurred while attempting to obtain the order's status.
shipment_details
array of object (ShipmentDetail)
A list of the individual shipments associated with the order and their current statuses.
Show
shipment_id
string
Unique identifier for the shipment associated with the order.
status
string
A string representing the current status of the shipment
id
integer
| int32
An integer that serves as a unique identifier for the shipment detail
bag_list
array of integer
A list of bag identifiers associated with the shipment.
meta
object (Meta)
Show
kafka_emission_status
integer
| int32
An integer representing the status of the message upon emission to Kafka. 0 indicates success, while 1 indicates failure.
state_manager_used
string
A string that specifies the state manager utilized for handling the order's state.
remarks
string
A string for any additional comments or notes related to the shipment,
text
string
A label or description of the delivery status, such as 'Expected Delivery Date'.
value
string
The detailed delivery status or time information, such as 'Arriving on 24 Nov 2022 15:54:00'.
color_code
string
Hex code for the color representing the delivery status.
expected_delivery_date
string
| date-time
The ISO 8601 formatted date and time when the delivery is expected, e.g., '2022-11-24T22:15:54+00:00'.
delivery_slot
object
Nullable
Represents a specific time window allocated for the delivery of an order or shipment.
order
object (OrderDetailsData)
Show
order_date
string
| date-time
Nullable
Represents the date and time when the order was placed by the customer. This timestamp is essential for tracking the initiation of the order process, scheduling deliveries, and analyzing order timelines.
created_ts
string
Nullable
A timestamp indicating when the order was created in the system.
tax_details
object
Nullable
Contains a flexible and comprehensive set of key-value pairs detailing the tax calculations and classifications applicable to the order.
cod_charges
string
Nullable
The charges associated with Cash on Delivery (COD) payments.
source
string
Nullable
The source from which the order originated.
fynd_order_id
string
An unique identifier for the order.
affiliate_id
string
Nullable
Affiliate id associated with order.
affiliate_order_id
string
Nullable
Affiliate order id associated with order.
ordering_channel_logo
object
Nullable
Represents the logo of the channel through which the order was placed, encapsulating branding elements and any relevant styling attributes. This object is designed to be flexible, allowing for the inclusion of various properties that define how the logo should be displayed across different platforms or documents related to the order.
order_value
string
Nullable
The total monetary value of the order
ordering_channel
string
Nullable
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Ordering source, to be used to identify source of order creation.
loyalty_discount_details
object (LoyaltyDiscountDetails)
Show
Object containing detailed information about the loyalty discount applied during an order.
discount
number
Discount amount applied by redeeming loyalty points while placing the order. Represents the monetary value of loyalty points redeemed.
ownership
string
Indicates who bears the cost of the loyalty discount, such as the seller or the marketplace.
Enum
is_applied
boolean
Specifies whether the loyalty discount has been applied to the order.
meta
object
Meta data of the order contains additional, potentially dynamic information about the order.
user
object (UserDataInfo)
Show
Contains the details of the user who created the order including identifying information and relevant metadata.
id
integer
Nullable
The unique identifier associated with the user.
user_oid
string
Nullable
The object ID for the user, used for referencing the user in various operations.
mongo_user_id
string
Nullable
The identifier for the user.
external_customer_id
string
Nullable
The identifier for the user in external systems.
first_name
string
Nullable
The first name of the user.
last_name
string
Nullable
The last name of the user.
mobile
string
Nullable
The mobile phone number of the user.
email
string
Nullable
The email address of the user.
meta
object
Nullable
Additional metadata related to the user.
is_anonymous_user
boolean
Nullable
Indicates whether the user is an anonymous user (true) or registered (false).
name
string
Nullable
A full name of the user, which may be a combination of first and last name.
gender
string
Nullable
The gender of the user.
country_phone_code
string
The country-specific phone code, useful for formatting mobile numbers correctly.
enable_dp_tracking
boolean
Nullable
A flag indicating whether the delivery partner tracking feature is enabled for this shipment.
custom_message
string
Nullable
A custom message or note associated with the shipment.
estimated_sla_time
string
Nullable
The estimated service level agreement (SLA) time for the shipment, indicating expected delivery timelines.
estimated_sla_ts
string
Nullable
A timestamp indicating when the estimated SLA time is expected to be met.
can_update_dimension
boolean
Nullable
Indicates whether the dimensions of the shipment can be updated after creation.
shipment_images
array of string
Nullable
A list of URLs for images related to the shipment.
delivery_details
object
A list of details about the delivery of an order.
billing_details
object
Information regarding the billing for the shipment, including billing address and payment method.
forward_shipment_id
string
Nullable
The ID of the parent forward journey shipment.
fulfilment_priority
integer
Nullable
The fulfilment priority, with lower numbers indicating a higher priority.
shipment_details
object (ShipmentLockDetails)
Show
lock_status
boolean
Nullable
Represents the lock status of the shipment.
lock_message
string
Nullable
A user-friendly message that explains the reason for locking the shipment.
action_to_status
object
Nullable
This field maps potential actions (e.g., downloading an invoice or label) to their corresponding shipment lock statuses, indicating which operations are allowed depending on the shipment's current lock status. When an action is set to 'lock', it means no transitions or updates to the shipment's status can be performed until the specified action is completed. For instance, if 'download_invoice' is in a 'lock' state, the shipment cannot undergo any status transitions until the invoice is either downloaded. Similarly, 'download_label' being in a 'lock' state prevents any shipment status transitions until a new label is downloaded.
custom_meta
array of object
Nullable
An array of custom metadata objects that may contain additional, dynamic information specific to the shipment.
shipment_quantity
integer
Nullable
The total quantity of items included in the shipment.
company_details
object (CompanyDetails)
Show
company_name
string
Nullable
The name of the company.
address
object
Nullable
It contains the properties for the address of a company.
company_cin
string
Nullable
The Corporate Identification Number (CIN) of the company.
company_id
integer
Nullable
A unique identifier for the company on the platform.
company_gst
string
Nullable
The Goods and Services Tax (GST) number of the company.
company_contact
object (ContactDetails)
Show
phone
array of object (PhoneDetails)
Nullable
An array of phone numbers associated with the contact.
Show
country_code
integer
Nullable
Identifies the country of the user's phone number using the two-character standard ISO 3166-1 alpha-2 country codes. Examples include 'US' for the United States and 'IN' for India.
number
string
Nullable
The actual phone number of the user.
emails
array of string
Nullable
An array of email addresses associated with the contact.
ordering_store
object (OrderingStoreDetails)
Show
phone
string
Nullable
The contact phone number for the ordering store.
pincode
string
Nullable
The postal code associated with the ordering store's location.
meta
object
Nullable
Meta data of the ordering store contains additional, potentially dynamic information about the ordering store.
address
string
Nullable
The complete address of the ordering store.
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
Formatted address based on the title-template provided by the partner.
id
integer
Nullable
A unique identifier for the ordering store.
code
string
Nullable
A specific code associated with the ordering store.
store_name
string
Nullable
The name of the ordering store.
country
string
Nullable
The country in which the ordering store is located.
contact_person
string
Nullable
The name of the primary contact person at the ordering store.
state
string
Nullable
The state or region where the ordering store is situated.
city
string
Nullable
The city in which the ordering store is located.
name
string
Nullable
The name of the ordering store.
store_email
string
Nullable
The email address of the ordering store.
order_platform
string
The platform used to place the order.
lock_status
boolean
Nullable
Indicates whether the shipment is currently locked or not for modifications or updates.
platform_logo
string
Nullable
The URL of the ordering platform's logo.
user_agent
string
Nullable
Information about the user agent string, typically containing details about the browser or application used to place the order.
dp_details
object (DPDetailsData)
Show
pincode
string
Nullable
The postal code associated with the delivery partner's location
track_url
string
Nullable
A URL that provides access to real-time tracking information for the shipment.
eway_bill_id
string
Nullable
The unique identifier for the e-way bill generated for the shipment.
id
integer
Nullable
A unique identifier for the delivery partner details.
country
string
Nullable
The country in which the delivery partner operates.
awb_no
string
Nullable
The Air Waybill number, a tracking number used for air freight shipments, allowing for the identification and tracking of the package in transit.
gst_tag
string
Nullable
A tag associated with the Goods and Services Tax (GST) for the shipment.
name
string
Nullable
The name of the delivery partner or service provider responsible for transporting the shipment.
invoice_id
string
Nullable
The unique identifier for the invoice associated with the shipment.
payment_methods
object
Nullable
This field stores a collection of payment method objects used in a transaction. Each key within this object represents a unique payment method code (e.g., "COD" for Cash On Delivery), and its value is an object containing detailed information about that payment method. The structure is designed to accommodate any number of payment methods,providing flexibility and comprehensive insights into each transaction's payment aspect.
payment_info
array of object
Nullable
An array of objects containing detailed information about the payments made for the shipment.
coupon
object
Nullable
Coupon data of the shipment which denotes if coupon is applied, coupon code, coupon amount, coupon title and coupon message.
affiliate_details
object (AffiliateDetails)
Show
Details of an affiliate associated with a shipment.
shipment_meta
object (ShipmentMeta)
Show
tracking_url
string
Nullable
A URL for tracking the shipment.
estimated_delivery_date
string
| date-time
Nullable
Provides a forecasted date and time by which the shipment is expected to be delivered to the recipient. This estimation is crucial for planning purposes, both for the sender in managing expectations and for the recipient in preparing for receipt.
same_store_available
boolean
Indicates whether the shipment is available for pickup from the same store.
b2b_buyer_details
object (BuyerDetails)
Show
ajio_site_id
string
Nullable
The unique identifier for the buyer on the Ajio platform.
pincode
integer
The postal code for the buyer's shipping address, used for delivery location identification.
address
string
Provides the comprehensive address details of the buyer's shipping address.
gstin
string
The Goods and Services Tax Identification Number (GSTIN) of the buyer.
name
string
The full name of the buyer, essential for personalizing communication and delivery.
state
string
The name of the state where the buyer's shipping address is located, important for logistical purposes.
city
string
The name of the city where the buyer's shipping address is located, which helps in identifying delivery zones.
formatted
object (Formatted)
Show
max
string
Nullable
Represents the maximum formatted value, providing a limit for the associated data, such as dimensions or weights.
min
string
Nullable
Represents the minimum formatted value, establishing a lower limit for the associated data, ensuring it meets certain criteria or standards.
debug_info
object (DebugInfo)
Show
stormbreaker_uuid
string
Nullable
A unique identifier (UUID) associated with the Stormbreaker system, used for tracking and debugging purposes in the application.
return_awb_number
string
Nullable
The Air Waybill (AWB) number associated with a return shipment.
is_self_ship
boolean
Nullable
Indicates whether the shipment is a self-shipped order.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
einvoice_info
object (EinvoiceInfo)
Show
credit_note
object
Nullable
Specifies the reverse einvoice transaction create on government portal.
invoice
object
Nullable
It specifies the forward einvoice transaction created on government portal.
return_affiliate_shipment_id
string
Nullable
The shipment ID associated with a return from an affiliate.
parent_dp_id
string
Nullable
The unique identifier for the parent delivery partner.
shipment_weight
number
Nullable
The total weight of the shipment.
dimension
object (Dimensions)
Show
height
number
Nullable
The height measurement of the object, typically representing the vertical dimension.
width
number
Nullable
The width measurement of the object, indicating the horizontal dimension.
is_default
boolean
Nullable
A flag indicating whether these dimensions are the default measurements for the object.
unit
string
Nullable
The unit of measurement used for the dimensions (e.g., centimeters, inches).
length
number
Nullable
The length measurement of the object, representing the longest dimension.
dp_options
object
Nullable
Delivery partner options that are available to deliver the shipment.
assign_dp_from_sb
boolean
Nullable
Indicates whether to assign the delivery partner from the store’s basket.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
store_invoice_updated_date
string
| date-time
Nullable
Denotes the date and time when the store's invoice related to this shipment was updated. This timestamp is vital for tracking changes to billing details, adjustments in charges, or updates in the invoicing status.
forward_affiliate_shipment_id
string
Nullable
The shipment ID for the forward journey of an affiliate shipment.
return_store_node
integer
Nullable
The identifier for the store node involved in the return process.
fulfilment_priority_text
string
Nullable
Textual representation of the fulfillment priority for the shipment.
shipment_tags
array of object (ShipmentTags)
Tags associated with the shipment for categorization and filtering.
Show
slug
string
Nullable
A URL-friendly string representing the tag, often used for routing or categorization.
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
display_text
string
Nullable
A human-readable text representation of the tag, used for display purposes in user interfaces.
external
object
Nullable
External metadata related to the shipment.
awb_number
string
Nullable
The Air Waybill number associated with the shipment.
lock_data
object (LockData)
Show
locked
boolean
Nullable
Indicates whether the shipment is currently locked for processing (true) or not (false).
mto
boolean
Nullable
A flag indicating whether the shipment is part of a multi-modal transport operation.
lock_message
string
Nullable
An optional message providing additional context or information regarding the lock status.
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.
Enum
ewaybill_info
object
Nullable
Electronic Way Bill details i.e ewayBillNo, ewayBillDate that are utilized in the transportation of goods.
dp_id
string
Nullable
The unique identifier for the delivery partner associated with the shipment.
shipment_volumetric_weight
number
Nullable
The volumetric weight of the shipment, which may differ from its actual weight.
marketplace_store_id
string
Nullable
The unique identifier for the marketplace store associated with the shipment.
return_details
object
Nullable
An object containing the return details of the shipment.
dp_sort_key
string
Nullable
A sort key for the delivery partner, used for prioritization.
packaging_name
string
Nullable
The name of the packaging used for the shipment.
timestamp
object (ShipmentTimeStamp)
Show
max
integer
Nullable
Represents the maximum timestamp value, indicating the latest time relevant to the shipment.
min
integer
Nullable
Represents the minimum timestamp value, indicating the earliest time relevant to the shipment.
auto_trigger_dp_assignment_acf
boolean
Nullable
Indicates whether automatic delivery partner assignment is triggered for this shipment.
dp_name
string
Nullable
The name of the delivery partner associated with the shipment.
po_number
string
Nullable
The purchase order number associated with the shipment.
weight
integer
The weight of the shipment, typically measured in grams or kilograms.
b2c_buyer_details
object
Nullable
Contains detailed information about the buyer in a business-to-consumer (B2C) transaction. This object is designed to capture a wide array of buyer-specific data such as contact information, shipping address, preferences, and any other relevant details that enhance the understanding of the buyer's profile and needs.
forward_affiliate_order_id
string
Nullable
The order ID for the forward journey of an affiliate shipment.
return_affiliate_order_id
string
Nullable
The order ID for the return journey of an affiliate shipment.
bag_weight
object
Nullable
This object is designed to accommodate a range of weight-related information. Denotes the weight of the bag, potentially including various measurements or related details.
refund_to
string
Nullable
Specifies the recipient of any refunds related to the shipment.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
affiliate_shipment_id
string
The shipment ID specific to this affiliate.
company_affiliate_tag
string
Nullable
An optional tag representing the company's affiliate association.
affiliate_order_id
string
The order ID associated with the affiliate shipment.
pdf_links
object (PDFLinks)
Show
invoice_type
string
The type of invoice issued, such as 'fynd' or other classifications.
Enum
label_a6
string
Nullable
URL or path to the A6 size label document.
invoice
string
Nullable
URL or path to the main invoice document.
label_pos
string
Nullable
URL or path to the POS label document.
invoice_a6
string
Nullable
URL or path to the A6 size invoice document.
b2b
string
Nullable
URL or path to the B2B document related to the transaction.
label
string
Nullable
URL or path to the general label document.
label_a4
string
Nullable
URL or path to the A4 size label document.
label_type
string
Specifies the type of label associated with a PDF document,indicating its purpose or content. The label_type helps in organizing and identifying PDF documents quickly, ensuring that users or systems can efficiently utilize the correct documents for required actions.
Enum
invoice_export
string
Nullable
URL or path to the exported invoice document.
credit_note_url
string
Nullable
URL or path to the credit note document.
delivery_challan_a4
string
Nullable
URL or path to the A4 delivery challan document.
label_export
string
Nullable
URL or path to the exported label document.
invoice_a4
string
Nullable
URL or path to the A4 size invoice document.
invoice_pos
string
Nullable
URL or path to the POS invoice document.
po_invoice
string
Nullable
URL or path to the purchase order invoice document.
config
object (AffiliateConfig)
Show
app
object (AffiliateAppConfig)
Show
id
string
description
string
updated_at
string
| date-time
The date and time when the app config was updated.
name
string
token
string
meta
array of object (AffiliateAppConfigMeta)
Show
value
string
name
string
owner
string
secret
string
created_at
string
| date-time
Timestamp when the app config was created.
inventory
object (AffiliateInventoryConfig)
Show
article_assignment
object (AffiliateInventoryArticleAssignmentConfig)
Show
post_order_reassignment
boolean
payment
object (AffiliateInventoryPaymentConfig)
Show
source
string
mode_of_payment
string
inventory
object (AffiliateInventoryStoreConfig)
Show
store
object
Fulfilling store information related to the shipment.
order
object (AffiliateInventoryOrderConfig)
Show
force_reassignment
boolean
logistics
object (AffiliateInventoryLogisticsConfig)
Show
dp_assignment
boolean
app_company_id
integer
Nullable
A unique identifier for the company associated with the affiliate app, used for tracking and managing affiliate relationships.
affiliate_id
string
Nullable
The unique identifier for the affiliate.
affiliate_store_id
string
The unique identifier for the affiliate's store.
affiliate_bag_id
string
The unique identifier for the affiliate's bag.
id
string
Nullable
The unique identifier for the affiliate.
priority_text
string
Nullable
Text that indicates the priority level of the shipment.
bag_status_history
array of object (BagStatusHistory)
A history of status changes for bags associated with the shipment.
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
is_dp_assign_enabled
boolean
Nullable
A flag indicating whether delivery partner assignment features are enabled for the shipment.
bags
array of object (OrderBags)
A list of bags included in the shipment
Show
gst_details
object (GSTDetailsData)
Show
cgst_tax_percentage
number
Nullable
The percentage of Central Goods and Services Tax (CGST) applicable on the goods or services.
gstin_code
string
Nullable
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.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
gst_fee
number
The total GST fee charged on the goods or services.
igst_tax_percentage
number
Nullable
The percentage of Integrated Goods and Services Tax (IGST) applicable for inter-state transactions.
gst_tax_percentage
number
Nullable
The overall GST tax percentage applicable to the goods or services.
hsn_code_id
string
Nullable
Unique identifier for the Harmonized System of Nomenclature (HSN) code used to classify goods.
igst_gst_fee
number
Nullable
The GST fee applicable for IGST, usually for inter-state transactions.
is_default_hsn_code
boolean
Nullable
Indicates whether this HSN code is the default classification for the goods.
sgst_gst_fee
number
Nullable
The GST fee applicable for State Goods and Services Tax (SGST).
tax_collected_at_source
number
Tax amount collected at the source of income or transaction, often for compliance and revenue tracking.
brand_calculated_amount
number
Amount calculated by the brand, potentially reflecting costs, fees, or pricing structures.
cgst_gst_fee
number
Nullable
The GST fee applicable for CGST.
gst_tag
string
Nullable
A tag or label used to denote GST-related attributes or classifications.
sgst_tax_percentage
number
Nullable
The percentage of State Goods and Services Tax (SGST) applicable on the goods or services.
hsn_code
string
Nullable
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.
bag_status
array of object (BagStatusHistory)
Show
forward
boolean
Nullable
Indicates whether the bag is being forwarded to the next stage in the shipment process.
store_id
integer
Nullable
Unique identifier for the store associated with the bag's current status.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number used for tracking the delivery of the bag.
kafka_sync
boolean
Nullable
Indicates if the status update has been synchronized with Kafka for real-time processing.
delivery_partner_id
integer
Nullable
Identifier for the delivery partner responsible for the shipment.
app_display_name
string
Nullable
The display name of the application that is handling the bag status update.
state_id
integer
Nullable
Unique identifier for the current state of the bag in the shipment process.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
Enum
bsh_id
integer
Nullable
Unique identifier for the bag status history entry.
created_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was created.
created_ts
string
Nullable
Timestamp of creation in a different format, if applicable.
shipment_id
string
Nullable
Identifier for the shipment associated with this bag status entry.
updated_at
string
| date-time
Nullable
Timestamp when the bag status history transaction was last updated.
updated_ts
string
Nullable
Timestamp of last update in a different format, if applicable.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
Unique identifier for the bag whose status is being tracked.
reasons
array of object
Nullable
List of reasons associated with the current status of the bag.
status
string
Current status of the bag in the shipment process.
display_name
string
Nullable
User-friendly name that describes the current state of the bag.
parent_promo_bags
object
Nullable
An object containing details of parent promotional bags.
seller_qc_details
object (SellerQcDetails)
Nullable
Show
Provides the seller's quality control details for a bag while accepting return items, including the line number reference and the quantities of items that passed or failed QC.
line_number
integer
Represents the line number in an order or transaction associated with the bag.
bad_quantity
integer
Represents the total number of items in a bag that have failed quality control and are marked as bad QC.
good_quantity
integer
Represents the total number of items in a bag that have passed quality control and are marked as good QC.
financial_breakup
object (FinancialBreakup)
Show
refund_credit
number
The amount of refund credits applicable for the transaction.
amount_paid_roundoff
integer
Nullable
Total amount paid, rounded off to the nearest integer for billing purposes.
price_effective
number
The effective price after applying discounts and before any taxes.
promotion_effective_discount
number
The amount of discount applied from promotional offers.
transfer_price
number
The fixed selling price applicable for payouts by the brand.
coupon_effective_discount
number
The discount applied through a coupon code, if applicable.
gst_fee
number
Total Goods and Services Tax (GST) fee charged on the goods or services.
tax_collected_at_source
number
Nullable
Tax amount collected at the source of income or transaction.
brand_calculated_amount
number
Amount calculated by the brand, possibly reflecting various costs or fees.
delivery_charge
number
Fee applicable for the delivery of the goods.
gst_tag
string
A tag used to denote GST-related attributes or classifications.
hsn_code
string
The HSN Code (Harmonized System of Nomenclature Code) is an internationally standardized system for classifying goods, used in trade and commerce for uniform identification across different countries.
cashback
number
The cashback amount provided to the customer, if applicable.
item_name
string
The name or description of the item related to the financial breakup.
value_of_good
number
The assessed value of the goods before applying any taxes or fees.
cashback_applied
number
The effective cashback value that has been applied to the transaction.
cod_charges
number
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
The indicated price or value assigned to an item before any discounts or adjustments.
size
string
The size of the item, if applicable.
amount_paid
number
Total amount paid by the customer for the transaction.
coupon_value
number
The effective value of the coupon used in the transaction.
discount
number
Total amount discounted from the original price of the goods.
fynd_credits
number
Credits provided by Fynd to the customer, possibly as part of a rewards program.
gst_tax_percentage
number
The percentage of GST applicable on the goods or services.
amount_to_be_collected
number
Amount to be collected in case of multiple modes of payments.
identifiers
object (Identifier)
Show
alu
string
Nullable
The ALU (Article Level Unit) code used to identify the item at a detailed level, often specific to certain retail or distribution systems.
ean
string
Nullable
The European Article Number (EAN) is a unique identifier for products, primarily used in retail and logistics. It helps in tracking and managing inventory across various platforms.
sku_code
string
Nullable
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.
upc
string
Nullable
The Universal Product Code (UPC) is a barcode symbol used for tracking trade items in stores. It is widely used in North America and helps in identifying products quickly during point-of-sale transactions.
isbn
string
Nullable
The International Standard Book Number (ISBN) is a unique identifier for books, allowing for easier management and tracking of book inventories in retail and library systems.
total_units
integer
The total number of units involved in the transaction.
added_to_fynd_cash
boolean
Indicates whether the amount has been added to Fynd cash for future use.
taxes
array of object (TaxComponent)
Applied Tax Components
Show
Represents a detailed breakdown of a specific tax component applied to a transaction or item.
This schema provides information about the type of tax, the rate at which it is applied,
the calculated tax amount, and the base amount on which the tax is computed.
name
string
The name or type of the tax component (e.g., GST, VAT, Service Tax).
This helps in identifying the specific tax being applied to the transaction or item.
rate
number
| float
The percentage rate at which the tax is applied to the taxable amount.
This value is typically represented as a decimal (e.g., 0.18 for 18% tax).
tax_amount
number
| float
The total monetary value of the tax calculated for this component.
This is derived by applying the tax rate to the taxable amount.
taxable_amount
number
| float
The base amount on which the tax is calculated, excluding the tax itself.
This represents the value of goods or services before tax is applied.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
bag_configs
object (BagConfigs)
Show
is_returnable
boolean
Indicates whether the bag is eligible for return by the customer.
allow_force_return
boolean
A flag that determines if a forced return can be initiated for the bag.
is_active
boolean
A flag indicating whether the bag is active or not.
can_be_cancelled
boolean
A flag that determines if the bag can be cancelled.
enable_tracking
boolean
A flag that determines if shipment tracking is enabled for the bag.
is_customer_return_allowed
boolean
A flag that determines if customer return is allowed for the bag.
is_bundle_item
boolean
Flag to indicate whether the bag is part of a bundle.
bundle_details
object (BundleDetails)
Show
Contains bundle-related metadata for the shipment.
bundle_group_id
string
Unique group identifier for the bundle.
name
string
Name of the bundle.
slug
string
URL-friendly identifier for the bundle.
bundle_count
integer
Indicates bundle count of the bag.
article_bundle_id
string
Unique identifier for the article bundle.
bundle_article_quantity
integer
Article net_quantity in bundle Product.
is_base
boolean
A flag that determines if bag is base bag of bundle.
price_marked
number
Maximum Retail Price of the bundle.
price_effective
number
Current selling price of the bundle.
item_id
integer
Unique identifier for the item.
item_type
string
Type of the item (physical_bundle, virtual_bundle).
Enum
return_config
object (BundleReturnConfig)
Show
Refund Config for bundle product
allow_partial_return
boolean
Nullable
Indicates whether partial returns are allowed for bundle products.
returnable
boolean
Nullable
Indicates whether the bundle product is returnable.
unit
boolean
Nullable
Time unit for the return window (e.g., "week", "day", "hour").
time
boolean
Nullable
Duration value for the return window, expressed in the specified unit.
seller_identifier
string
Identifier for the seller of the bundle.
images
array of string
An array of image URLs associated with the bundle.
brand_name
string
Identifier for the brand name.
size
string
Size associated with the bundle item.
seller_identifier
string
Nullable
delivery_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
article
object (OrderBagArticle)
Show
identifiers
object
Nullable
Details of Identifiers associated with the article.
return_config
object (ReturnConfig)
Show
returnable
boolean
Nullable
Indicates whether the article is eligible for return, allowing customers to send it back under specified conditions.
time
number
Nullable
The time frame within which the return must be initiated, typically measured in days.
unit
string
Nullable
The unit of time for the return period (e.g., days, weeks).
uid
string
Nullable
A unique identifier for the article within the order bag.
size
string
Nullable
The size of the article, which may be relevant for clothing.
tags
array of string
Nullable
An array of tags associated with the article.
_custom_json
object
Nullable
A custom JSON object containing additional details or configurations specific to the article.
brand
object (OrderBrandName)
Show
logo
string
Nullable
A URL or path to the logo image associated with the brand.
company
integer
Nullable
A unique identifier for the company associated with the brand.
id
integer
A unique identifier for the brand within the system.
created_on
string
| date-time
Nullable
Timestamp when the brand of the order was created.
brand_name
string
Nullable
The name of the brand associated with the order.
modified_on
string
| date-time
Nullable
Timestamp when the brand of the order was modified.
group_id
string
Nullable
affiliate_bag_details
object (AffiliateBagsDetails)
Show
affiliate_bag_id
string
Nullable
A unique identifier for the affiliate bag.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
affiliate_meta
object (AffiliateMeta)
Show
order_item_id
string
Nullable
A unique identifier for the order item associated with the affiliate shipment.
channel_order_id
string
Nullable
The order ID assigned by the sales channel for tracking purposes.
employee_discount
number
Nullable
The discount percentage or amount applied to the order for employees.
box_type
string
Nullable
Box type of the shipment in which the shipment will be delivered.
quantity
integer
Nullable
The total quantity of items in the order.
size_level_total_qty
integer
Nullable
The total quantity of items grouped by size level for the order.
loyalty_discount
number
| float
The discount percentage or amount applied to the order based on customer loyalty.
replacement_details
object (ReplacementDetails)
Show
replacement_type
string
Nullable
Specifies the nature or category of the replacement requested or processed for an item.
original_affiliate_order_id
string
Nullable
The original order ID associated with the item that is being replaced.
channel_shipment_id
string
Nullable
The shipment ID assigned by the sales channel for tracking purposes.
marketplace_invoice_id
string
Nullable
The invoice ID related to the marketplace for the transaction.
due_date
string
| date-time
Nullable
Specifies the deadline by which a particular action related to the affiliate shipment needs to be completed.
coupon_code
string
Nullable
A unique code provided to customers for redeeming special offers or discounts on their purchases.
is_priority
boolean
Nullable
Indicates whether the shipment is a priority for fulfillment.
is_serial_number_required
boolean
Nullable
Indicates whether a serial number is required for the items in the shipment.
fulfilment_priority
integer
Nullable
A value indicating the priority level of order fulfillment.
customer_selling_price
number
Nullable
The selling price at which the product is offered to the customer.
item
object (PlatformItem)
Show
id
integer
Nullable
Unique identifier for the platform item.
attributes
object (PlatformArticleAttributes)
Show
currency
string
Nullable
The currency in which the price of the article is specified.
brand_id
integer
Nullable
Identifier for the brand associated with the item.
slug_key
string
Nullable
A user-friendly string that represents the item, often used in URLs.
l3_category
integer
Nullable
Represents the product's classification at the third level in the e-commerce platform's category hierarchy, using an integer identifier.
l3_category_name
string
Nullable
Name of the third-level category under which the product is listed.
last_updated_at
string
| date-time
Nullable
Timestamp when any aspect of the associated record was modified, formatted as date-time.
name
string
Nullable
The name of the product item.
l2_category
array of string
Nullable
Represents the second level of categorization for items, helping customers narrow down their search.
brand
string
Nullable
Name of the brand associated with the item.
image
array of string
Nullable
Array of image URLs representing the item.
code
string
Nullable
Unique code for the item, often used for inventory management.
l1_category
array of string
Nullable
Represents the highest or top-tier level of categorization for the product.
size
string
Nullable
Size specification of the product, if applicable.
can_cancel
boolean
Nullable
Indicates whether the item can be canceled after order placement.
can_return
boolean
Nullable
Indicates whether the item is eligible for return.
branch_url
string
Nullable
URL linking to a specific branch or store where the item is available.
meta
object
Nullable
Meta data containing additional, dynamic information about the item.
color
string
Nullable
Color specification of the product, if applicable.
department_id
integer
Nullable
Identifier for the department associated with the product.
images
array of string
Nullable
Array of image URLs representing different views or angles of the item.
tags
array of string
Nullable
Custom labels or keywords associated with the item for categorization, filtering, or business logic purposes.
payment_methods
array of object (BagPaymentMethods)
An array detailing the various payment methods utilized for the transaction. Each item within this array represents a distinct method of payment. It encapsulates the details of various payment methods available for completing a transaction. It includes comprehensive information such as the payment mode, amount, transaction status, and identifiers for each payment method.
Show
mode
string
Nullable
The payment mode used for the transaction.
amount
number
Nullable
The total amount associated with the payment method
payment_info
array of object (BagPaymentMethods)
Show
mode
string
Nullable
The payment mode used for the transaction.
amount
number
Nullable
The total amount associated with the payment method
quantity
integer
Nullable
The number of items contained in the bag.
identifier
string
Nullable
A unique identifier for the bag.
can_return
boolean
Nullable
Indicates whether the items in the bag are eligible for return by the customer.
can_cancel
boolean
Nullable
Indicates whether the bag is eligible for cancellation by the customer.
display_name
string
Nullable
A user-friendly name for the bag.
line_number
integer
Nullable
A unique identifier for each line item in a bag.
meta
object
Meta data of the bags contains additional, potentially dynamic information about the bags.
applied_promos
array of object (AppliedPromos)
Show
promotion_type
string
Nullable
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
promotion_name
string
Nullable
The name of the promotional campaign or offer.
discount_rules
array of object (DiscountRules)
A list of rules that define the conditions under which discounts are applied.
Show
value
integer
Nullable
type
string
Nullable
amount
number
Nullable
The total monetary value of the discount or promotion.
article_quantity
integer
Nullable
The quantity of articles required to qualify for the promotion.
buy_rules
array of object (BuyRules)
A list of rules that outline the conditions for purchasing items under the promotion.
Show
Rules of promotion which suffies then only the promotion is applied.
item_criteria
object (ItemCriterias)
Show
item_brand
array of integer
Nullable
cart_conditions
object
Nullable
Specifies the rules that must be met at the cart level for any purchasing rules or promotional discounts to be applied. Specifically, it includes criteria such as the total quantity of items in the cart. For instance, a rule might require that the cart contains at least one item for the promotion to apply. This setup allows for the dynamic application of discounts or special buying rules based on cart conditions.
promo_id
string
Nullable
A unique identifier for the promotion.
mrp_promotion
boolean
Nullable
A flag that designates whether or not the promotion is an MRP (manufacturer's reduced price) promotion.
applied_free_articles
array of object (AppliedFreeArticles)
A list of articles that are eligible for free under the promotion.
Show
article_id
string
A unique identifier for the article to which the free gift is applied.
free_gift_item_details
object (FreeGiftItems)
Details of the free gift item associated with the article, including relevant attributes like name, description, and any other specifications.
Show
item_slug
string
A unique identifier for the item, typically used in URLs for SEO purposes.
item_name
string
The name of the item.
item_price_details
object (ItemPriceDetails)
Show
marked
object (PriceMinMax)
Show
min
number
| float
The minimum price value. Represents the lowest price in the price range.
max
number
| float
The maximum price value. Represents the highest price in the price range.
effective
object (PriceMinMax)
Show
min
number
| float
The minimum price value. Represents the lowest price in the price range.
max
number
| float
The maximum price value. Represents the highest price in the price range.
currency
string
The currency in which the prices details associated with the item is specified.
item_brand_name
string
The brand name of the item.
item_id
integer
| int32
A unique numerical identifier for the item.
item_images_url
array of string
A list of URLs pointing to images of the item.
parent_item_identifier
string
An identifier for the parent item with which the free gift is associated, typically used to link the free gift to the original purchased item.
quantity
number
The quantity of the free gift items applied to the article.
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
current_status
object (CurrentStatus)
Show
store_id
integer
Nullable
A unique identifier for the store associated with the shipment.
delivery_awb_number
string
Nullable
The Air Waybill (AWB) number for the delivery.
kafka_sync
boolean
Nullable
A flag indicating whether the current status is synchronized with Kafka or not.
delivery_partner_id
integer
Nullable
A unique identifier for the delivery partner responsible for handling the shipment.
state_type
string
Nullable
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey, including route optimization and carrier selection.
Enum
state_id
integer
Nullable
A unique identifier for the specific state of the shipment.
id
integer
A unique identifier for the current status entry
created_at
string
| date-time
Nullable
Denotes the date and time when the bag status was created.
created_ts
string
| date-time
Nullable
A timestamp indicating when the status was created
shipment_id
string
Nullable
A unique identifier for the shipment.
updated_at
string
| date-time
Nullable
The date and time when the current status was last updated.
bag_state_mapper
object (BagStateMapper)
Show
is_active
boolean
Nullable
Indicates whether the state is currently active in the shipment process.
app_display_name
string
Nullable
Display name used in the application to represent this state.
state_type
string
Serves as a key identifier to differentiate among the diverse types
of states a shipment can undergo throughout its journey.
- 'operational': Pertains to states that involve the physical handling and movement of the shipment, such as packing, in transit, and delivery.
- 'financial': Relates to states associated with the payment, invoicing, and any monetary transactions or obligations tied to the shipment.
- 'logistics': Encompasses states that deal with the broader logistical planning and coordination necessary for the shipment's journey,
including route optimization and carrier selection.
Enum
id
integer
journey_type
string
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
app_state_name
string
Nullable
The name of the state as used within the application, providing a clear reference.
name
string
Official name of the state in the context of the shipment process.
app_facing
boolean
Nullable
Indicates if this state is visible to the customer in the application.
notify_customer
boolean
Nullable
Indicates whether the customer should be notified upon reaching this state.
display_name
string
User-friendly name for the state, suitable for display purposes.
bag_id
integer
Nullable
A unique identifier for the bag associated with the shipment.
status
string
Nullable
A descriptive label representing the current status of the shipment.
bag_id
integer
entity_type
string
Nullable
Type of entity that the tag is associated to (bag, shipments).
Enum
is_parent
boolean
Nullable
A flag indicating whether the current bag is a parent entity or not.
dp_assignment
boolean
Nullable
Indicates whether a delivery partner has been assigned to the shipment.
total_items
integer
Nullable
The total number of items contained within the shipment,
fulfilling_store
object (FulfillingStore)
Show
phone
string
The contact phone number for the fulfilling store.
pincode
string
The postal code for the fulfilling store's location.
meta
object
Meta data of the fulfilling store contains additional, potentially dynamic information about the fulfilling store.
address
string
The complete address of the fulfilling store.
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
Display friendly version of the Fulfilment Store Address.
id
integer
The unique id or identifier of a fulfilment store.
code
string
The unique code of the fulfilment store.
store_name
string
The unique name of a fulfillment store.
country
string
The name of the country associated with a specific fulfilment store.
fulfillment_channel
string
The channel through which fulfillment is managed.
contact_person
string
The name of the contact person associated with a fulfilling store.
state
string
The state or region where the fulfilling store is located.
city
string
The city in which the fulfilling store is situated.
store_email
string
Nullable
The email address of the fulfilling store.
meta
object
Meta data of the shipment contains additional, potentially dynamic information about the shipment.
pdf_links
object
PDF Links associated with the shipment.
payment_mode
string
Nullable
The mode of payment used for the shipment.
packaging_type
string
Nullable
Defines the type of packaging used for the product, encompassing materials, design, and form factors.
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
prices
object (Prices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc.
refund_credit
number
Nullable
Refund credits applicable to the customer in case of returns or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid, rounded off to the nearest integer.
price_effective
number
Nullable
Effective price after applying discounts to the MRP (Maximum Retail Price).
promotion_effective_discount
number
Nullable
Discount amount provided through promotions applicable to the purchase.
pm_price_split
number
Nullable
Updated selling price of the product in the event of repricing.
refund_amount
number
Nullable
Total amount to be refunded in case of cancellation or return.
transfer_price
number
Nullable
Fixed selling price applicable for payouts by the brand to the platform.
coupon_effective_discount
number
Nullable
Discount amount applicable when using a coupon.
tax_collected_at_source
number
Nullable
Tax amount collected at the source during the transaction.
brand_calculated_amount
number
Nullable
Calculated price after deducting coupon and promotion discounts from the effective price.
delivery_charge
number
Nullable
Fee charged for delivery, as stipulated by the delivery partner.
cashback
number
Nullable
Cashback points or amount provided to the customer post-purchase.
value_of_good
number
Nullable
Effective selling price minus the GST amount applicable to the product.
cashback_applied
number
Nullable
Actual cashback value that has been applied to the purchase.
cod_charges
number
Nullable
Charges applicable for Cash on Delivery (COD) orders.
price_marked
number
Nullable
The marked price of the item before any discounts or adjustments.
amount_paid
number
Nullable
Total amount actually paid by the customer for the purchase.
coupon_value
number
Nullable
The effective value of the coupon applied to the transaction.
discount
number
Nullable
Total discount amount deducted from the original price of the product.
fynd_credits
number
Nullable
Credits awarded by Fynd, which can be used for future purchases.
gift_price
number
Nullable
The amount associated with any gift card used in the transaction.
amount_to_be_collected
number
Nullable
Total amount to be collected in scenarios involving multiple payment methods.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
marketplace_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the marketplace or platform (e.g., Fynd). Marketplace promotions are created and funded by the platform itself to drive sales, attract customers, or run platform-wide campaigns. The cost of these promotions is borne by the marketplace, not the seller.
seller_promotion_effective_discount
number
Nullable
The share of the promotion discount funded by the seller. Seller promotions are created and funded by the individual seller or brand to boost their own product sales. The cost of these promotions is borne entirely by the seller.
charges
array of object (PriceAdjustmentCharge)
An array of charges applied to the shipment.
Show
Price adjustment charge injected, used to refer the charge injected for the entity such as Order, shipment, article
code
string
Nullable
Code defined for charge
name
string
Display name for charge (charge is unique by the name)
type
string
Nullable
Type defined for charge
amount
object (ChargeAmount)
Show
Charge amount schema, amount defined for the charges
base_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
ordering_currency
object (ChargeAmountCurrency)
Show
Charge amount currency currency schema
value
number
Charge currency value or amount
currency
string
Charge currency code
distribution_logic
object (ChargeDistributionLogic)
Show
Charge amount distribution logic, config by which charge will assign to the entity or distribution_level
distribution
object (ChargeDistributionSchema)
Show
Charge distribution structure, used to refer the distribution logic for the entity such as Order, shipment, article
type
string
This field defines the distribution type, e.g values('multi', 'single')
multi: distribute the changes across all entity
single: distribute the changes across to any one single entity
Enum
logic
string
This field defines the distribution logic e.g values('apportion', 'equally') apportion: distribute charge amount based of weighted average amount of all the entity (like article with
[10, 20] will get charge of 9 as [3, 6])
equally: distribute charge amount 'equally' to all the entity
distribution_level
string
This field defines the distribution level, e.g distribution level is (order, shipment, article)
ordering_currency_prices
object (OrderingCurrencyPrices)
Show
Details of all the charges, cashback, refunds, taxes, coupons, etc in currency used by customer.
refund_credit
number
Nullable
Amount of refund credits applicable to the customer's account for returned items or cancellations.
amount_paid_roundoff
number
Nullable
Total amount paid by the customer, rounded off to the nearest integer for ease of processing.
price_effective
number
Nullable
Final effective price of the product after applying discounts to the marked retail price (MRP).
promotion_effective_discount
number
Nullable
Total discount amount applied through promotional offers specific to the customer's purchase.
pm_price_split
number
Nullable
Updated selling price of the product after any repricing adjustments made before the sale.
refund_amount
number
Nullable
Amount that will be refunded to the customer in case of order cancellation or product return.
transfer_price
number
Nullable
Fixed price set for payouts by the brand, representing the cost to the retailer or affiliate.
coupon_effective_discount
number
Nullable
Discount value realized through the use of a coupon code applied at the time of purchase.
tax_collected_at_source
number
Nullable
Total tax amount that is collected at the point of sale, often applicable for tax regulations.
brand_calculated_amount
number
Nullable
Amount calculated by the brand after applying any relevant coupons and promotions to the base price.
delivery_charge
number
Nullable
Cost charged for the delivery service, as determined by the delivery partner handling the shipment.
cashback
number
Nullable
Points or monetary value returned to the customer as a reward for their purchase, which can be used for future transactions.
value_of_good
number
Nullable
Net selling price of the product after excluding the GST (Goods and Services Tax) amount from the total.
cashback_applied
number
Nullable
Total cashback value that has been applied to the customer's account or to the current transaction.
cod_charges
number
Nullable
Additional fee charged for orders placed via cash on delivery (COD) payment method.
price_marked
number
Nullable
The original price indicated for the product before any discounts or promotions are applied.
amount_paid
number
Nullable
The total amount the customer has paid for their order, including all applicable charges and discounts.
coupon_value
number
Nullable
The specific value of the coupon used in the transaction, reflecting its impact on the total price.
discount
number
Nullable
Total amount discounted from the original price of the product, reflecting savings for the customer.
fynd_credits
number
Nullable
Credits provided by Fynd, which can be used for discounts on future purchases.
gift_price
number
Nullable
Monetary value assigned to a gift card purchased by the customer, usable for future transactions.
amount_to_be_collected
number
Nullable
Amount to be collected from the customer when multiple payment methods are utilized for a single order.
cost_price
number
Nullable
The base cost incurred by the seller to acquire or produce the product before margin or discount.
loyalty_discount
number
| float
Amount reduced from the payable price when the customer applies loyalty program points while placing the order.
vertical
string
Nullable
The business vertical or category to which the shipment belongs.
shipment_id
string
A unique identifier for the shipment.
payments
object (ShipmentPayments)
Show
mode
string
Nullable
The payment mode used for the shipment.
logo
string
Nullable
A URL or path to the logo associated with the payment method.
source
string
Nullable
The source or origin of the payment
operational_status
string
Nullable
The operational status of the shipment.
status
object (ShipmentStatusData)
Show
meta
object
Nullable
It contains the additional properties related to shipment status transition like Kafka_emission_status, user_name, etc. Additionally it is dynamic.
bag_list
array of string
Nullable
The list of bags that are in this shipment status transition.
id
integer
Nullable
Unique identifier for a shipment status.
created_at
string
| date-time
Nullable
Denotes the date and time when the transition was created.
created_ts
string
Nullable
A timestamp indicating when the status entry was created.
shipment_id
string
Nullable
The unique identifier for the shipment.
status
string
Nullable
The current status of the shipment.
display_name
string
Nullable
A user-friendly name or description of the current shipment status.
current_shipment_status
string
Nullable
Reflects the most recent status of the shipment.
status_created_at
string
| date-time
Nullable
Denotes the date and time when the transition of the status of the shipment was created.
total_bags
integer
Nullable
The total number of bags in the shipment.
shipment_created_at
string
| date-time
Nullable
Denotes the date and time when the shipment was created.
shipment_created_ts
string
Nullable
A timestamp representing when the shipment was created.
currency
object (Currency)
Show
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.
currency_symbol
string
The symbol representing the currency.
currency_info
object (CurrencyInfo)
Show
ordering_currency
object (OrderingCurrency)
Show
currency_code
string
This specifies the currency code for all amounts.
currency_name
string
The full name of the currency.
currency_symbol
string
The symbol representing the currency.
currency_sub_unit
string
The sub-unit of the currency
conversion_rate
object (ConversionRate)
Show
base
string
The base currency code, example 'INR' for Indian Rupee, against which all conversion rates are calculated. Follows the ISO 4217 standard.This includes the currency's name, its conversion rate relative to the base currency ('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency conversion but also enriches the data with useful currency descriptors, enhancing financial operations and analyses.
rates
object
An object , where each key is a currency code and its value is an object containing detailed information
about that currency. This includes the currency's name, its conversion rate relative to the base currency
('value'), the currency symbol, and any sub-unit of the currency. This setup not only facilitates currency
conversion but also enriches the data with useful currency descriptors.
previous_shipment_id
string
Nullable
The ID of the previous shipment in the sequence.
shipment_update_time
number
Nullable
A numerical representation of the last update time for the shipment
rto_address
object (Address)
Nullable
Show
It contains the properties for the address of a user
phone
string
Nullable
The phone number at the address, used for contact purposes.
address2
string
Nullable
An optional additional field for the street address of the address.
address
string
Nullable
An optional additional field for the street address of the address.
longitude
number
Nullable
The longitude coordinate of the address.
pincode
string
Nullable
The postal code of the address.
area
string
Nullable
Area details of the address.
address_type
string
Nullable
The type of the address.
Enum
country
string
Nullable
The name of the country of the address.
address_category
string
Nullable
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.
addresses based on various business processes
- 'store': Identifies addresses associated with physical retail locations or warehouses which is essential for inventory management, order fulfillment, and facilitating in-store pickups or returns.
- 'delivery': Identifies addresses where orders are shipped to customers which ensures successful delivery, enhancing customer satisfaction, and optimizing logistics operations.
- 'billing': Identifies addresses used for billing and financial transactions which are essential for payment processing, invoice generation, and maintaining financial accuracy
Enum
email
string
Nullable
The email of the person associated with the order.
created_at
string
| date-time
Nullable
Created at date for address
address1
string
Nullable
The primary address dynamically forms based on a template. If the template
includes a single key, Address1 contains that data. For templates with multiple keys like
{address} {address2} {area} {state} {country}, Address1 compiles all into a single formatted string.
display_address
string
Nullable
A formatted version of the address for display purposes.
landmark
string
Nullable
A notable landmark near the address, aiding in location identification.
updated_at
string
| date-time
Nullable
Updated at date for address
version
string
Nullable
The version number of the address record
latitude
number
Nullable
The latitude coordinate of the address.
contact_person
string
Nullable
The full name of the person associated with the address.
state
string
Nullable
The name of the region (for example, province, state, or prefecture) of the address.
city
string
Nullable
The city, town of the address.
area_code_slug
string
Nullable
A slug representation of the area code.
country_code
string
Nullable
A code representing the country for the address.
country_iso_code
string
Nullable
The ISO code representing the country for the address.
country_phone_code
string
Nullable
The country-specific phone code for formatting phone numbers.
delivery_address_id
integer
A unique identifier for the delivery address.
geo_location
object
An object containing additional geographical information related to the address.
name
string
A unique identifier for the name associated with the address.
sector
string
The sector or zone of the address, if applicable.
state_code
string
A code representing the state or region for the address.
uid
string
A unique identifier for the user associated with the address.
user_id
string
The unique identifier of the user in the system.
code
string
Nullable
A unique identifier associated with store.
credit_note_id
string
Nullable
The identifier for any credit note issued for the shipment
is_self_ship
boolean
Nullable
A flag indicating whether the shipment is being self-shipped by the seller or vendor.
mode_of_payment
string
Nullable
The specific mode of payment used for the transaction
is_lapa_enabled
boolean
Flag to show NDR actions based on LAPA (Logistic As Per Actual) plan subscription. If LAPA plan taken, true, else false.
forward_end_shipment_id
string
Nullable
The forward_end_shipment_id represents the shipment ID of the original forward journey shipment. When a shipment is transitioned to a return journey, the original shipment ID from the forward journey is recorded in the forward_end_shipment_id field of the return journey shipment. Even if the return shipment is later split into multiple shipments, each of these shipments will retain the same forward_end_shipment_id value that was assigned during the initial return journey initiation. This ensures that all return shipments can be traced back to the original forward journey shipment.
logistics_meta
object
An object storing detailed logistics-related information, including courier partner details and other relevant metadata.
packages
array of object (PackageSchema)
Array of packages to be created or updated for the shipment. At least two packages are required for MPS functionality.
Show
id
string
Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.
packaging_id
string
Nullable
Optional reference to a predefined packaging configuration or template used for creating physical packages.
name
string
Nullable
A human-readable name or label for the package, used for identification and organizational purposes.
size
string
Nullable
The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.
package_type
string
Nullable
The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).
length
number
| float
Nullable
The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
width
number
| float
Nullable
The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
height
number
| float
Nullable
The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.
weight
number
| float
Nullable
The actual weight of the package in kilograms, including packaging materials and products.
error_rate
number
| float
Nullable
The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).
package_vol_weight
number
| float
Nullable
The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.
max_weight
number
| float
Nullable
The maximum weight capacity that this package can handle, used for validation and logistics planning.
awb
string
Nullable
Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.
pdf_links
object
Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.
Default Value : [object Object]
products
array of object (PackageProduct)
List of products contained within this package. Each product specifies its line number, quantity, and identifier.
Show
line_number
integer
The line number of the product within the shipment, used for tracking and identification purposes.
quantity
number
The quantity of the product included in this package.
identifier
string
The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.
Examples
Parameters
company_id:
1
channel_shipment_id:
"16731535496121004000"
shipment_id:
"16731535496121004000"
fetch_active_shipment:
false
allow_inactive:
false
Response