Skip to main content

Order

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

Bag

Bag represents a virtual entity to group same items which contains single or multi quantity. Bags are part of a shipment. An order will have one or more than one shipments. A shipment can contain zero or more bags.

Operations
GET
/service/application/order/v1.0/orders/shipments/{shipment_id}/bags/{bag_id}/reasons
# 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 bag. 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 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.
ShipmentBagReasons
reasons
array of object (BagReasons)
Array of BagReasons
success
boolean
Examples
Parameters
shipmentId:
"value"
bagId:
"value"
Was this section helpful?
GET
/service/application/order/v1.0/orders/shipments/{shipment_id}/bags/{bag_id}/reasons
Loading...
Response
Loading...

Order

Order represents a customer's intent to purchase a specific set of products from your platform. Here platform could be a Website, POS machine, External integrations etc. It typically includes details like customer information, billing/shipping addresses, items ordered, quantities, pricing, and chosen fulfillment method. Meta of an order can be edited.

Operations
GET
/service/application/order/v1.0/orders
# List customer orders
GET
/service/application/order/v1.0/orders/{order_id}
# Get an order
GET

List customer orders

Retrieves 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
UTC Start Date in ISO format
endDate
string
| date-time
UTC Start Date in ISO 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)
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
/service/application/order/v1.0/orders
Loading...
Response
Loading...
GET

Get an order

Retrieve 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
/service/application/order/v1.0/orders/{order_id}
Loading...
Response
Loading...

Shipment

Shipment represents the physical movement of goods from the seller (or your warehouse) to the customer. It's associated with a specific order and includes details like tracking information, carrier used, weight, dimensions, and estimated delivery date. An Order can contain multiple shipments. Shipments are created based on multiple factors like selling location assigned to that shipment, the packaging material available etc. A shipment will get created whenever there is a partial transition of items also when there is a negative state transition is invoked. Negative state transition can be defined against a state. Currently only some defined states are configured as negative. If any state is to be added as negative state then please contact support team.

Operations
GET
/service/application/order/v1.0/orders/shipments/{shipment_id}
# Get a Shipment
GET
/service/application/order/v1.0/orders/shipments/{shipment_id}/invoice
# Retrieves invoice for shipment
GET
/service/application/order/v1.0/orders/shipments/{shipment_id}/track
# Track shipment status
GET
/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/customer-details
# Get shipment's customer
POST
/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/send/
# Send OTP to customer
POST
/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/verify/
# Verifies OTP
GET
/service/application/order/v1.0/orders/shipments/{shipment_id}/reasons
# List shipment cancellation reasons
PUT
/service/application/order/v1.0/orders/shipments/{shipment_id}/status
# Updates shipment status
GET

Get a Shipment

Retrieve 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
/service/application/order/v1.0/orders/shipments/{shipment_id}
Loading...
Response
Loading...
GET

Retrieves invoice for shipment

Retrieve the 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
success
boolean
shipment_id
string
presigned_url
string
Examples
Parameters
shipmentId:
"value"
Was this section helpful?
GET
/service/application/order/v1.0/orders/shipments/{shipment_id}/invoice
Loading...
Response
Loading...
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)
Array of Track
Examples
Parameters
shipmentId:
"value"
Was this section helpful?
GET
/service/application/order/v1.0/orders/shipments/{shipment_id}/track
Loading...
Response
Loading...
GET

Get shipment's customer

Retrieve customer details such as mobile number using Shipment ID.
Parameters
orderId
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
shipmentId
string
Required
A unique number used for identifying and tracking your orders.
Default Value : FY6299E19701B4EAEFC2
Response
200
4XX
5XX
Success. Check the example shown below or refer `CustomerDetailsByShipmentId` for more details.
CustomerDetailsResponse
phone
string
shipment_id
string
name
string
order_id
string
country
string
Examples
Parameters
orderId:
"value"
shipmentId:
"value"
Was this section helpful?
GET
/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/customer-details
Loading...
Response
Loading...
POST

Send OTP to customer

Sends a one-time password (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
message
string
success
boolean
resend_timer
integer
Examples
Parameters
orderId:
"value"
shipmentId:
"value"
Was this section helpful?
POST
/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/send/
Loading...
Response
Loading...
POST

Verifies OTP

Confirms the OTP sent to the shipment customer for verification.
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
request_id
string
Response
200
4XX
5XX
Success, the code is valid and returns a session token
VerifyOtpResponse
success
boolean
Examples
Parameters
orderId:
"value"
shipmentId:
"value"
body:
body
Was this section helpful?
POST
/service/application/order/v1.0/orders/{order_id}/shipments/{shipment_id}/otp/verify/
Loading...
Response
Loading...
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)
Array of ShipmentReason
Examples
Parameters
shipmentId:
"value"
Was this section helpful?
GET
/service/application/order/v1.0/orders/shipments/{shipment_id}/reasons
Loading...
Response
Loading...
PUT

Updates shipment status

Modifies the 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)
Array of StatuesRequest
task
boolean
lock_after_transition
boolean
force_transition
boolean
unlock_before_transition
boolean
Response
200
4XX
5XX
Successfully updateShipmentStatus!
ShipmentApplicationStatusResponse
statuses
array of object (StatusesBodyResponse)
Array of StatusesBodyResponse
Examples
Parameters
shipmentId:
"value"
body:
body
Was this section helpful?
PUT
/service/application/order/v1.0/orders/shipments/{shipment_id}/status
Loading...
Response
Loading...