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
List bag cancellation reasons
Get reasons to perform full or partial cancellation of a bag.
Parameters
shipmentId
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.
bagId
string
Required
ID of the bag. An shipment may contain multiple items and may get divided into one or more bags, each having its own ID.
Response
200
4XX
5XX
Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
ShipmentBagReasons
reasons
array of object (BagReasons)
A list of shipment's bag reasons.
Array of BagReasons
success
boolean
Indicates if the operation was successful.
Examples
Parameters
shipmentId:
"value"
bagId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List bag cancellation reasons
getShipmentBagReasons
Order
Order represents a customer's intent to purchase a specific set of products from your platform. Here platform could be a Website, POS machine, External integrations etc. It typically includes details like customer information, billing/shipping addresses, items ordered, quantities, pricing, and chosen fulfillment method. Meta of an order can be edited.
Operations
GET
# List customer orders
GET
# Get an order
GET
List customer orders
Get all orders associated with a customer account.
Parameters
status
integer
A filter to retrieve orders by their current status such as 'placed', 'delivered' etc.
pageNo
integer
The page number to navigate through the given set of results. Default value is 1.
pageSize
integer
The number of items to retrieve in each page. Default value is 10.
fromDate
string
The date from which the orders should be retrieved.
toDate
string
The date till which the orders should be retrieved.
startDate
string
| date-time
Start date in UTC (ISO-8601 format).
endDate
string
| date-time
End date in UTC (ISO-8601 format).
customMeta
string
A filter and retrieve data using special fields included for special use-cases.
Default Value : 6388422a5ebd6a6cf4a8ede6
allowInactive
boolean
Flag indicating whether inactive shipments are allowed.
Default Value : false
Response
200
4XX
5XX
Success. Returns all the orders. Check the example shown below or refer `OrderList` for more details.
OrderList
page
object (OrderPage)
OrderPage
items
array of object (OrderSchema)
List of orders, each containing detailed information about individual orders and their respective shipments.
Array of OrderSchema
filters
object (OrderFilters)
OrderFilters
Examples
Parameters
status:
0
pageNo:
0
pageSize:
0
fromDate:
"value"
toDate:
"value"
startDate:
"value"
endDate:
"value"
customMeta:
"value"
allowInactive:
false
Was this section helpful?
GET
Loading...
Response
Loading...
List customer orders
getOrders
GET
Get an order
Get order details such as tracking details, shipment, store information using Fynd Order ID.
Parameters
orderId
string
Required
A unique number used for identifying and tracking an order.
allowInactive
boolean
Flag to allow inactive shipments.
Default Value : false
Response
200
4XX
5XX
Success. Check the example shown below or refer `OrderById` for more details.
OrderById
order
object (OrderSchema)
OrderSchema
Examples
Parameters
orderId:
"value"
allowInactive:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get an order
getOrderById
Shipment
Shipment represents the physical movement of goods from the seller (or your warehouse) to the customer. It's associated with a specific order and includes details like tracking information, carrier used, weight, dimensions, and estimated delivery date. An Order can contain multiple shipments. Shipments are created based on multiple factors like selling location assigned to that shipment, the packaging material available etc. A shipment will get created whenever there is a partial transition of items also when there is a negative state transition is invoked. Negative state transition can be defined against a state. Currently only some defined states are configured as negative. If any state is to be added as negative state then please contact support team.
Operations
GET
# Get a Shipment
GET
# Retrieves invoice for shipment
GET
# Track shipment status
GET
# Get shipment's customer
POST
# Send OTP to customer
POST
# Verifies OTP
GET
# List shipment cancellation reasons
PUT
# Updates shipment status
GET
Get a Shipment
Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID.
Parameters
shipmentId
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.
allowInactive
boolean
Flag to allow inactive shipments.
Default Value : false
Response
200
4XX
5XX
Success. Check the example shown below or refer `ShipmentById` for more details.
ShipmentById
shipment
object (Shipments)
Shipments
Examples
Parameters
shipmentId:
"value"
allowInactive:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Get a Shipment
getShipmentById
GET
Retrieves invoice for shipment
Get invoice corresponding to a specific shipment ID.
Parameters
shipmentId
string
Required
ID of the shipment.
Response
200
4XX
5XX
Success. Check the example shown below or refer `ShipmentById` for more details.
ResponseGetInvoiceShipment
presigned_type
string
Type of presigned URL.
success
boolean
Indicates if the operation was successful .
shipment_id
string
Identifier for the shipment.
presigned_url
string
The presigned URL for accessing the shipment data, obtained from the response data.
Examples
Parameters
shipmentId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Retrieves invoice for shipment
getInvoiceByShipmentId
GET
Track shipment status
Track Shipment by shipment id, for application based on application Id.
Parameters
shipmentId
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
Default Value : 16544950215681060915J
Response
200
4XX
5XX
Success. Check the example shown below or refer `ShipmentTrack` for more details.
ShipmentTrack
results
array of object (Track)
A array containing tracking details.
Array of Track
Examples
Parameters
shipmentId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Track shipment status
trackShipment
GET
Get shipment's customer
Get customer details such as mobile number using Shipment ID.
Parameters
orderId
string
Required
A unique number used for identifying and tracking your orders.
Default Value : 16544950215681060915J
shipmentId
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
Default Value : FY6299E19701B4EAEFC2
Response
200
4XX
5XX
Success. Check the example shown below or refer `CustomerDetailsByShipmentId` for more details.
CustomerDetailsResponse
phone
string
Customer's phone number.
shipment_id
string
Unique identifier of the shipment.
name
string
Customer's name.
order_id
string
Unique identifier of the order.
country
string
Country of the customer.
Examples
Parameters
orderId:
"value"
shipmentId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get shipment's customer
getCustomerDetailsByShipmentId
POST
Send OTP to customer
Send OTP to the customer for shipment verification.
Parameters
orderId
string
Required
A unique number used for identifying and tracking your orders.
Default Value : FY6299E19701B4EAEFC2
shipmentId
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
Default Value : 16544950215681060915J
Response
200
4XX
5XX
Success to acknowledge the service was notified
SendOtpToCustomerResponse
request_id
string
Unique identifier for the request.
message
string
Message indicating the result of the request.
success
boolean
Indicates whether the request was successful.
resend_timer
integer
Time in seconds before the OTP can be resent.
Examples
Parameters
orderId:
"value"
shipmentId:
"value"
Was this section helpful?
POST
Loading...
Response
Loading...
Send OTP to customer
sendOtpToShipmentCustomer
POST
Verifies OTP
Verify OTP sent by customer.
Parameters
orderId
string
Required
A unique number used for identifying and tracking your orders.
Default Value : FYMP6294545C010B89FD
shipmentId
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
Default Value : 16538880933361957252J
body
object (VerifyOtp)
Required
VerifyOtp
otp_code
string
The OTP code provided by the user for verification.
request_id
string
Unique identifier for the request.
Response
200
4XX
5XX
Success, the code is valid and returns a session token
VerifyOtpResponse
success
boolean
Indicates whether the request was successful.
Examples
Parameters
orderId:
"value"
shipmentId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Verifies OTP
verifyOtpShipmentCustomer
GET
List shipment cancellation reasons
Get reasons to perform full or partial cancellation of a shipment.
Parameters
shipmentId
string
Required
ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID.
Response
200
4XX
5XX
Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
ShipmentReasons
reasons
array of object (ShipmentReason)
A list of shipment reasons.
Array of ShipmentReason
Examples
Parameters
shipmentId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List shipment cancellation reasons
getShipmentReasons
PUT
Updates shipment status
Update current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings.
Parameters
shipmentId
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.
body
object (UpdateShipmentStatusRequest)
Required
UpdateShipmentStatusRequest
statuses
array of object (StatuesRequest)
An array containing different status details.
Array of StatuesRequest
task
boolean
Indicates whether the task is active or required.
lock_after_transition
boolean
Indicates whether the status should be locked after the transition.
force_transition
boolean
Indicates whether the transition should be forced.
unlock_before_transition
boolean
Indicates whether the status should be unlocked before the transition.
Response
200
4XX
5XX
Successfully updateShipmentStatus!
ShipmentApplicationStatusResponse
statuses
array of object (StatusesBodyResponse)
An array containing different status options of shipments.
Array of StatusesBodyResponse
Examples
Parameters
shipmentId:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...