Order
Manages orders, including processing, tracking, and updating order status.
Bag
Bag represents a virtual entity to group same items which contains single or multi quantity. Bags are part of a shipment. An order will have one or more than one shipments. A shipment can contain zero or more bags.
Operations
GET
# List bag cancellation reasons
GET
# Get bag
GET
# List bags
GET
List bag cancellation reasons
Get reasons to perform full or partial cancellation of a bag
Parameters
company_id
integer
Required
shipment_id
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
bag_id
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.
state
string
Required
State for which reasons are required.
Response
200
4XX
5XX
Success. Check the example shown below or refer `PlatformShipmentReasonsResponse` for more details.
PlatformShipmentReasonsResponse
reasons
array of object (Reason)
Array of Reason
success
boolean
Examples
Parameters
companyId:
1
shipmentId:
"value"
bagId:
"value"
state:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List bag cancellation reasons
getShipmentReasons
GET
Get bag
Retrieve detailed information about a specific bag
Parameters
company_id
integer
Required
Id of company
bag_id
string
Id of bag
channel_bag_id
string
Id of application bag
channel_id
string
Id of application
Response
200
4XX
5XX
Successfully retrived shipment details!
BagDetailsPlatformResponse
status_code
integer
data
object (BagDetails)
BagDetails
Examples
Parameters
companyId:
1
bagId:
"value"
channelBagId:
"value"
channelId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get bag
getBagById
GET
List bags
Get paginated list of bags based on provided filters
Parameters
company_id
integer
Required
Id of company
bag_ids
string
Comma separated values of bag ids
shipment_ids
string
Comma separated values of shipment ids
order_ids
string
Comma separated values of order ids
channel_bag_ids
string
Comma separated values of app bag ids
channel_shipment_ids
string
Comma separated values of app shipment ids
channel_order_ids
string
Comma separated values of app order ids
channel_id
string
Comma separated values of app ids
page_no
integer
Page number for paginated data
Default Value : 1
page_size
integer
Page size of data received per page
Default Value : 20
Response
200
4XX
5XX
Successfully retrived all the given shipments details!
GetBagsPlatformResponse
status_code
integer
data
object (BagData)
Nullable
BagData
Examples
Parameters
companyId:
1
bagIds:
"value"
shipmentIds:
"value"
orderIds:
"value"
channelBagIds:
"value"
channelShipmentIds:
"value"
channelOrderIds:
"value"
channelId:
"value"
pageNo:
1
pageSize:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List bags
getBags
Order
Order represents a customer's intent to purchase a specific set of products from your platform. Here platform could be a Website, POS machine, External integrations etc. It typically includes details like customer information, billing/shipping addresses, items ordered, quantities, pricing, and chosen fulfillment method.
Operations
POST
# Create order
GET
# Get channel configuration
POST
# Create channel configuration
POST
# Attach order to a user
GET
# Get order
GET
# List orders
POST
Create order
Creates an order
Parameters
company_id
integer
Required
Id of the company.
Request body
shipments
array of object (Shipment)
Required
Array of Shipment
shipping_info
object (ShippingInfo)
Required
ShippingInfo
billing_info
object (BillingInfo)
Required
BillingInfo
currency_info
object
external_order_id
string
charges
array of object (Charge)
Array of Charge
external_creation_date
string
meta
object
tax_info
object (TaxInfo)
TaxInfo
config
object (CreateOrderConfig)
CreateOrderConfig
payment_info
object (PaymentInfo)
Required
PaymentInfo
user_info
object (UserInfo)
UserInfo
ordering_store_id
integer
| int32
order_platform
string
Response
200
4XX
5XX
Successfully created an order!
CreateOrderResponse
fynd_order_id
string
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create order
createOrder
GET
Get channel configuration
Retrieve configuration settings specific to orders for a channel
Parameters
company_id
integer
Required
Response
200
4XX
5XX
Successfully created the config data
CreateChannelConfigData
config_data
object (CreateChannelConfig)
CreateChannelConfig
Examples
Parameters
companyId:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get channel configuration
getChannelConfig
POST
Create channel configuration
Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel
Parameters
company_id
integer
Required
Request body
config_data
object (CreateChannelConfig)
CreateChannelConfig
Response
200
4XX
5XX
Successfully updateShipmentStatus!
CreateChannelConfigResponse
is_inserted
boolean
is_upserted
boolean
acknowledged
boolean
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create channel configuration
createChannelConfig
POST
Attach order to a user
Attach an anonymous order to a customer based on OTP verification
Parameters
company_id
integer
Required
Request body
otp_data
object (AttachUserOtpData)
Required
AttachUserOtpData
fynd_order_id
string
Required
user_info
object (AttachUserInfo)
Required
AttachUserInfo
Response
200
4XX
Attach user to order
AttachOrderUserResponse
success
boolean
message
string
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Attach order to a user
attachOrderUser
GET
Get order
Get detailed information about a specific order
Parameters
company_id
integer
Required
Id of company
order_id
string
Required
Default Value : FY6299E19701B4EAEFC2
my_orders
boolean
allow_inactive
boolean
Flag to allow inactive shipments
Default Value : false
Response
200
4XX
We are processing the report!
OrderDetailsResponse
order
object (OrderData)
OrderData
success
boolean
shipments
array of object (PlatformShipment)
Array of PlatformShipment
Examples
Parameters
companyId:
1
orderId:
"value"
myOrders:
false
allowInactive:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get order
getOrderById
GET
List orders
Get a list of orders based on the filters provided
Parameters
company_id
integer
Required
Id of company
Default Value : 37
lane
string
lane refers to a section where orders are assigned, indicating its grouping
Default Value : new
search_type
string
search_type refers to the field that will be used as the target for the search operation
Default Value : shipment_id
bag_status
string
bag_status refers to status of the entity. Filters orders based on the status.
time_to_dispatch
integer
time_to_dispatch refers to estimated SLA time.
Enum
payment_methods
string
tags
string
tags refers to additional descriptive labels associated with the order
search_value
string
search_value is matched against the field specified by the search_type
Default Value : 16854460524441037000
from_date
string
to_date
string
start_date
string
end_date
string
dp_ids
string
Delivery Partner IDs to which shipments are assigned.
stores
string
sales_channels
string
page_no
integer
page_size
integer
is_priority_sort
boolean
Default Value : true
custom_meta
string
Default Value : 6388422a5ebd6a6cf4a8ede6
my_orders
boolean
show_cross_company_data
boolean
Flag to view cross & non-cross company order
Default Value : false
customer_id
string
order_type
string
allow_inactive
boolean
Flag indicating whether inactive shipments are allowed
Default Value : false
Response
200
4XX
We are processing the report!
OrderListingResponse
total_count
integer
Nullable
message
string
Nullable
success
boolean
Nullable
items
array of object (PlatformOrderItems)
Array of PlatformOrderItems
lane
string
Nullable
page
object (Page)
Page
Examples
Parameters
companyId:
1
lane:
"value"
searchType:
"value"
bagStatus:
"value"
timeToDispatch:
1
paymentMethods:
"value"
tags:
"value"
searchValue:
"value"
fromDate:
"value"
toDate:
"value"
startDate:
"value"
endDate:
"value"
dpIds:
"value"
stores:
"value"
salesChannels:
"value"
pageNo:
1
pageSize:
1
isPrioritySort:
false
customMeta:
"value"
myOrders:
false
showCrossCompanyData:
false
customerId:
"value"
orderType:
"value"
allowInactive:
false
Was this section helpful?
GET
Loading...
Response
Loading...
List orders
getOrders
Order State Manager
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.
POST
Allows esm config updation
Update ESM config
Parameters
company_id
integer
Required
The Id Of The Company.
Request body
data
object (TransitionConfigData)
TransitionConfigData
Response
200
4XX
Config updated successfully
ConfigUpdatedResponse
data
array of object (ConfigData)
The result of the config update operation, including whether it was acknowledged, upserted, or inserted.
Array of ConfigData
success
boolean
Indicates whether the config update operation was successful.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Loading...
Response
Loading...
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_id
integer
Required
The unique identifier of the company.
app_id
string
The unique identifier of the application.
ordering_channel
string
The channel through which orders are placed.
entity
string
The entity for which the configuration is applied.
Response
200
4XX
This denotes a successful response. ESM config data fetched successfully for given application ID, ordering channel, and entity.
Properties
success
boolean
Indicates whether the request was successful.
data
array of object
An array of ESM configuration objects.
Array of Properties
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Retrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
getStateManagerConfig
Shipment
Shipment represents the physical movement of goods from the seller (or your warehouse) to the customer. It's associated with a specific order and includes details like tracking information, carrier used, weight, dimensions, and estimated delivery date. An Order can contain multiple shipments. Shipments are created based on multiple factors like selling location assigned to that shipment, the packaging material available etc. A shipment will get created whenever there is a partial transition of items also when there is a negative state transition is invoked. Negative state transition can be defined against a state. Currently only some defined states are configured as negative. If any state is to be added as negative state then please contact support team.
Operations
POST
# Reassign location
POST
# Update a shipment lock
POST
# 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
# List shipments
GET
# Get shipment
POST
Reassign location
Reassign the shipment to a another location and update its status to 'Store Reassigned.'
Parameters
company_id
integer
Required
Request body
store_id
integer
| int32
Required
bag_id
integer
| int32
Nullable
affiliate_order_id
string
Nullable
affiliate_id
string
Nullable
item_id
string
Nullable
fynd_order_id
string
Nullable
set_id
string
Nullable
affiliate_bag_id
string
Nullable
reason_ids
array of integer
Nullable
mongo_article_id
string
Nullable
Response
200
4XX
Successfully reassigned location!
StoreReassignResponse
success
boolean
message
string
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Reassign location
reassignLocation
POST
Update a shipment lock
Modify shipment/bag lock and check status.
Parameters
company_id
integer
Required
Request body
entity_type
string
Required
Expected entity_type: [bags, shipments]
Enum
action
string
Required
Expected Actions: [lock, unlock, check]
Enum
action_type
string
Required
Expected action_type: [complete, operational, financial]
Enum
entities
array of object (Entities)
Required
Shipment/Entity
Array of Entities
resume_tasks_after_unlock
boolean
Nullable
lock_after_transition
boolean
Lock Shipment After Transition
unlock_before_transition
boolean
Unlock Shipment After Transition
Response
200
4XX
Successfully update the Lock and get check status of the shipment/Bag
UpdateShipmentLockResponse
success
boolean
message
string
check_response
array of object (CheckResponse)
Entity Lock Status, If the action input as 'check'
Array of CheckResponse
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update a shipment lock
updateShipmentLock
POST
Update shipment address
Modify the address details of an existing shipment
Parameters
shipment_id
string
Required
name
string
address
string
address_type
string
pincode
string
phone
string
email
string
landmark
string
address_category
string
Required
city
string
state
string
country
string
company_id
integer
Required
Response
200
4XX
Update Address will be processed!
BaseResponse
success
boolean
message
string
Examples
Parameters
shipmentId:
"value"
name:
"value"
address:
"value"
addressType:
"value"
pincode:
"value"
phone:
"value"
email:
"value"
landmark:
"value"
addressCategory:
"value"
city:
"value"
state:
"value"
country:
"value"
companyId:
1
Was this section helpful?
POST
Loading...
Response
Loading...
Update shipment address
updateAddress
PUT
Update a shipment's status
Used for updating a shipment and its status. Can also be used for updating bags present in that shipment.
Parameters
company_id
integer
Required
company id from where are transitioning the shipment state or data
Request body
force_transition
boolean
Force Transition
statuses
array of object (StatuesRequest)
Array of StatuesRequest
lock_after_transition
boolean
Lock Shipment After Transition
unlock_before_transition
boolean
Unlock Shipment After Transition
task
boolean
To Run Status Update as a background Task
resume_tasks_after_unlock
boolean
Resume Tasks After Unlock
Response
200
4XX
NOTE success response can contains success and failed result as well
UpdateShipmentStatusResponseBody
statuses
array of object (StatuesResponse)
Array of StatuesResponse
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a shipment's status
updateShipmentStatus
GET
Get a shipment's history
Get the history of the shipment
Parameters
company_id
integer
Required
Company Id
shipment_id
string
Shipment Id
bag_id
integer
Bag/Product Id
Response
200
4XX
5XX
It shows the journey of the shipment!
ShipmentHistoryResponse
success
boolean
activity_history
array of object (HistoryDict)
Array of HistoryDict
Examples
Parameters
companyId:
1
shipmentId:
"value"
bagId:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get a shipment's history
getShipmentHistory
POST
Create shipment history
Used to add logs in history for a bag for the provided Shipment ID
Parameters
company_id
integer
Required
Request body
activity_history
array of object (PostHistoryDict)
Array of PostHistoryDict
Response
200
4XX
5XX
It shows the journey of the shipment!
ShipmentHistoryResponse
success
boolean
activity_history
array of object (HistoryDict)
Array of HistoryDict
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create shipment history
postShipmentHistory
POST
Update packaging dimensions
Used to modify the packaging dimension of a shipment
Parameters
company_id
integer
Required
Request body
shipment_id
string
Required
current_status
string
Required
dimension
array of object (Dimension)
Required
Array of Dimension
Response
200
4XX
Manifest will be processed!
UpdatePackagingDimensionsResponse
message
string
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update packaging dimensions
updatePackagingDimensions
POST
Send user mobile OTP
Send a one-time OTP to a customer mobile number
Parameters
company_id
integer
Required
Request body
mobile
string
Required
country_code
string
Response
200
4XX
Send OTP to user mobile
SendUserMobileOtpResponse
success
boolean
message
string
data
object (PointBlankOtpData)
PointBlankOtpData
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Send user mobile OTP
sendUserMobileOTP
POST
Verify mobile OTP
Perform OTP verification to link a user to an anonymous order
Parameters
company_id
integer
Required
Request body
otp_data
object (VerifyOtpData)
Required
VerifyOtpData
fynd_order_id
string
Required
Response
200
4XX
Verify OTP
VerifyOtpResponse
status
integer
| int32
success
boolean
message
string
data
object (VerifyOtpResponseData)
VerifyOtpResponseData
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Verify mobile OTP
verifyMobileOTP
POST
Retry E-invoice
Reattempt the generation of an E-invoice
Parameters
company_id
integer
Required
Request body
shipments_data
array of object (EInvoiceRetryShipmentData)
Array of EInvoiceRetryShipmentData
Response
200
400
500
E-invoice generated successfully for all/few shipments from given list of shipments.
EInvoiceRetryResponse
response_data
array of object (EInvoiceResponseData)
Array of EInvoiceResponseData
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Retry E-invoice
eInvoiceRetry
GET
Track shipment
Retrieve courier partner tracking details for a given shipment Id or AWB number
Parameters
company_id
string
Required
Company ID
shipment_id
string
Shipment ID
awb
string
AWB number
page_no
integer
Page number
page_size
integer
Page size
Response
200
4XX
Shipment Tracking fetched successfully
CourierPartnerTrackingResponse
items
array of object (CourierPartnerTrackingDetails)
Array of CourierPartnerTrackingDetails
page
object (PageDetails)
PageDetails
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Track shipment
trackShipment
POST
Update shipment tracking
Modify courier partner tracking details for a given shipment Id or AWB number
Parameters
company_id
integer
Required
Company ID
Request body
awb
string
Required
AWB Number
dp_location
string
Nullable
Current location of Courier partner
dp_name
string
Required
Courier Partner name
dp_status
string
Required
Status at Courier partner end
dp_status_updated_at
string
| date-time
Required
Date Time at which status was updated at Courier partner
estimated_delivery_date
string
| date-time
Nullable
Estimated delivery date received from Courier partner
id
integer
| int32
Id of Tracking history
journey
string
Required
Journey type of the shipment
Enum
meta
object
Meta field to store Courier partner's meta data
operational_status
string
Required
Operational status of OMS
promised_delivery_date
string
| date-time
Nullable
Promised delivery date received from Courier partner
remark
string
Nullable
Remark from courier partner
shipment_id
string
Required
Shipment ID
Response
200
4XX
Shipment Tracking updated successfully
CourierPartnerTrackingDetails
awb
string
AWB Number
dp_location
string
Nullable
Current location of Courier partner
dp_name
string
Courier Partner name
dp_status
string
Status at Courier partner end
dp_status_updated_at
string
| date-time
Date Time at which status was updated at Courier partner
estimated_delivery_date
string
| date-time
Nullable
Estimated delivery date received from Courier partner
id
integer
| int32
Id of Tracking history
journey
string
Journey type of the shipment
Enum
meta
object
Meta field to store Courier partner's meta data
operational_status
string
Operational status of OMS
promised_delivery_date
string
| date-time
Nullable
Promised delivery date received from Courier partner
remark
string
Nullable
Remark from courier partner
shipment_id
string
Shipment ID
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update shipment tracking
updateShipmentTracking
POST
Generate and attach invoice Id
Generate and attach Invoice Ids against shipments.
Parameters
company_id
integer
Required
company id from where are transitioning the shipment state or data
invoice_type
string
Required
mention the type of invoice id to generate
Request body
shipment_ids
array of string
Required
Response
200
4XX
NOTE success response can contains success and failed result as well
GenerateInvoiceIDResponse
items
array of object (GenerateInvoiceIDResponseData)
Array of GenerateInvoiceIDResponseData
Examples
Parameters
companyId:
1
invoiceType:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Generate and attach invoice Id
generateInvoiceID
GET
List shipments
Get a list of shipments based on the filters provided
Parameters
company_id
integer
Required
Id of company
lane
string
Name of lane for which data is to be fetched
Enum
bag_status
string
Comma separated values of bag statuses
status_override_lane
boolean
Use this flag to fetch by bag_status and override lane
Default Value : false
time_to_dispatch
integer
Enum
search_type
string
Search type key
search_value
string
Search type value
from_date
string
| date
Start Date in DD-MM-YYYY format
to_date
string
| date
End Date in DD-MM-YYYY format
start_date
string
| date-time
UTC Start Date in ISO format
end_date
string
| date-time
UTC End Date in ISO format
dp_ids
string
Comma separated values of delivery partner ids
stores
string
Comma separated values of store ids
sales_channels
string
Comma separated values of sales channel ids
page_no
integer
Page number for paginated data
Default Value : 1
page_size
integer
Page size of data received per page
Default Value : 10
fetch_active_shipment
boolean
flag to fetch active shipments
Default Value : true
allow_inactive
boolean
Flag to allow inactive shipments
Default Value : false
exclude_locked_shipments
boolean
flag to fetch locked shipments
Default Value : true
payment_methods
string
Comma separated values of payment methods
channel_shipment_id
string
App Shipment Id
channel_order_id
string
App Order Id
custom_meta
string
ordering_channel
string
company_affiliate_tag
string
my_orders
boolean
platform_user_id
string
sort_type
string
Sort the result data on basis of input
Default Value : sla_asc
Enum
show_cross_company_data
boolean
Flag to view cross & non-cross company order
Default Value : false
tags
string
Comma separated values of tags
customer_id
string
order_type
string
Response
200
4XX
We are processing the report!
ShipmentInternalPlatformViewResponse
total_count
integer
Nullable
message
string
Nullable
success
boolean
Nullable
items
array of object (ShipmentItem)
Array of ShipmentItem
lane
string
Nullable
page
object (Page)
Page
Examples
Parameters
companyId:
1
lane:
"value"
bagStatus:
"value"
statusOverrideLane:
false
timeToDispatch:
1
searchType:
"value"
searchValue:
"value"
fromDate:
"value"
toDate:
"value"
startDate:
"value"
endDate:
"value"
dpIds:
"value"
stores:
"value"
salesChannels:
"value"
pageNo:
1
pageSize:
1
fetchActiveShipment:
false
allowInactive:
false
excludeLockedShipments:
false
paymentMethods:
"value"
channelShipmentId:
"value"
channelOrderId:
"value"
customMeta:
"value"
orderingChannel:
"value"
companyAffiliateTag:
"value"
myOrders:
false
platformUserId:
"value"
sortType:
"value"
showCrossCompanyData:
false
tags:
"value"
customerId:
"value"
orderType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List shipments
getShipments
GET
Get shipment
Get detailed information about a specific shipment
Parameters
company_id
integer
Required
Id of company
channel_shipment_id
string
App Shipment Id
shipment_id
string
Shipment Id
fetch_active_shipment
boolean
flag to fetch active or deactivated shipments
allow_inactive
boolean
Flag indicating whether inactive shipments are allowed
Default Value : false
Response
200
4XX
We are processing the report!
ShipmentInfoResponse
message
string
Nullable
success
boolean
shipments
array of object (PlatformShipment)
Array of PlatformShipment
Examples
Parameters
companyId:
1
channelShipmentId:
"value"
shipmentId:
"value"
fetchActiveShipment:
false
allowInactive:
false
Was this section helpful?
GET
Loading...
Response
Loading...