Order Management API

This section familiarizes you with the Standard Fulfilment and Self Ship APIs in the Order Management framework.

Refer to the Glossary for information on orders related datatypes.

Standard Fulfilment

Forward Flow

Order Status Details Seller Actions
Approved New orders that the seller needs to process by marking them as “Packed”; downloading the required labels, invoices, and forms; and marking the shipments as “Ready to Dispatch” to notify the logistics team.

Cancel Order

A seller can cancel these orders if not in a position to fulfill them.

Packing List Download

A seller can download the list containing the details of approved orders and item attributes to ensure correct packing.

Pack Order

A seller can mark approved orders as “Packed” to start downloading the labels, invoices, and forms.

Packing in Process The orders that have packing in progress in addition to generation of labels, invoices, and forms N.A.
Packed The orders that are packed and the required labels, invoices, and forms are ready to download.

Download Labels

A seller must download the labels, invoices, and forms generated for the respective order item to complete the packing process.

Mark as “Ready to Dispatch”

A seller must mark orders as “Ready to Dispatch” to trigger the shipment pickup request for the logistics team.

Ready for Dispatch The orders that the sellers have successfully marked as “Ready to Dispatch” and the logistics team has scheduled a pickup for.

Download Manifest

A seller must download the manifest, which has the list of orders ready to handover to the logistics team.

Returns Flow

Return Status Details Seller Actions
Created New return created on an approved seller order item. N.A.
Completed Product returned to the seller. N.A.
Cancelled Return cancelled, item is not expected to reach the seller warehouse. N.A.

Self Ship Fulfilment

For Self Ship fulfilment, the order item and service item state life cycle is:

https://img1a.flixcart.com/fk-api-docs/_static/images/SelfshipFwdFlow.jpg

Forward Flow

A Self Ship order may have two aspects of fulfilment:

  • Physical delivery of the product
  • Post-delivery services such as assembly, installation, etc.

Important

Sellers must ensure that they dispatch, deliver, and complete post-delivery services for the self-ship order within the respective pre-defined SLAs for the order and service item.

Order Status Details Seller Actions
Approved New orders that the seller needs to process by marking them as “Dispatched” and providing necessary invoicing and logistics details

Cancel Order

A seller can cancel these orders if not in a position to fulfill them.

Dispatch Order

A seller needs to update approved orders as “Dispatched” by providing details of invoice (invoice number, VAT/CST percentage) and logistics (courier partner name, AWB No., expected delivery date). This must be done before the Dispatch_By_Date to avoid dispatch SLA breach.

Shipped Dispatched orders in transit

Delivery Attempt

A seller can update delivery status on an order if: (a) delivery was attempted, (b) customer was unavailabile, (c) mutual agreement between the seller and customer to reschedule delivery, or (d) due to an issue at the seller’s end. With this update, both the delivery attempt date and a new expected delivery date is required.

Delivery Confirmation

A seller needs to update delivery confirmation on an order after successful completion of delivery of a product to the customer. Delivery date is required with this update. This is expected to be done before the Deliver_By_Date to avoid delivery SLA breach.

Delivered The orders that have been delivered to the customer, but are pending post-delivery service such as assembly, etc.

Service Attempt

A seller can update service completion on an order if service was attempted but could not happen as: (a) customer was unavailable, (b) there’s mutual agreement between the seller and customer to reschedule service, or (c) there’s an issue at seller’s end. With this update, both service attempt date and a new expected service completion date is required.

Service Completion

A seller needs to update service confirmation on an order after successful completion of service of product to the customer. With this update, service completion date is required. This is expected to be done before Service_By_Date to avoid service SLA

Completed The orders that the sellers have successfully fulfilled to the buyer’s satisfaction N.A.

Associated Actions

Cancel order

Order: Approved → Cancelled

Service: Activated → Cancelled

Dispatch order

Order: Approved → Shipped

Delivery attempt

Increase in SLA for delivery.

Confirm delivery

If service item present:

Order: Shipped → Delivered

Service: Activated → In Progress

If no service item present:

Order: Shipped → Delivered → Complete

Service attempt

Increase in SLA for service completion

Service complete

Delivered → Complete

Order: Delivered → Complete

Service: In Progress → Complete

Returns Flow

The return item lifecycle is:

https://img1a.flixcart.com/fk-api-docs/_static/images/SelfShipReturnsFlow.png

Self Ship returns are of two types:

  • Courier returns (RVP)
    • Created due to buyer cancellations while the product is in transit to the customers
    • Customers can cancel the order any time depending on the cancellation policy associated with the product
    • These returns must be acknowledged or cancelled by sellers after verification of the product delivery status
    • If courier return is approved, seller needs to ensure it is not delivered to the customer and brought back to the warehouse
    • If courier return is cancelled, the forward fulfilment order item is updated as delivered
  • Customer returns (RTO)
    • Created after delivery of the product to customers
    • Customers can request a return due to an issue with service (assembly/installation), quality (bad/defective/damaged) product, or due to wrong shipment
    • These returns must be approved or rejected by sellers after the a tech visit (or troubleshooting), as applicable
    • If returns are approved, seller needs to ensure product pickup from the customer
    • If returns are approved and a replacement order has been created, seller needs to fulfill it as any other Self Ship order
Return Status Details Seller Actions
Requested These are typically customer returns (RVP) that need your attention in terms of tech visit/troubleshooting the issue customer is facing. Post completion of tech visit, the seller needs to approve or reject the return.

RVP: Tech Visit Attempt

A seller can update tech visit attempt on a return tech visit service item in case troubleshooting was attempted but could not happen due to customer unavailability, mutual agreement between seller and customer to reschedule tech visit or due to some issue at seller’s end.

With this update, tech visit attempt date as well as a new expected tech visit date is required.

RVP: Approve Return A seller can mark a customer return as approved post completion of tech visit. This is expected to be done before Tech_Visit_By date to avoid tech visit completion SLA breach.

RVP: Reject Return

A seller can mark a customer return as rejected post completion of tech visit.

This is expected to be done before Tech_Visit_By date to avoid tech visit completion SLA breach.

Approved

These returns can either be approved customer returns (RVP) or courier returns (RTOs).

In case of customer returns, reverse pickup confirmation is required to complete the return.

In case of courier returns, RTO acknowledgement or cancellation is required to complete or close the return.

RVP: Reverse Pickup Attempt

A seller can update reverse pickup attempt on an approved customer return in case pickup was attempted but could not happen due to customer unavailability, mutual agreement between seller and customer to reschedule reverse pickup or due to some issue at seller’s end.

With this update, reverse pickup attempt date as well as a new expected reverse pickup date is also required.

RVP: Reverse Pickup Confirmation

A seller needs to update a customer return as completed post confirmation of reverse pickup.

This is expected to be done before Reverse_Pickup_By date to avoid return completion SLA breach.

RTO: Acknowledge RTO

A seller needs to acknowledge buyer cancellation and confirm RTO after ensuring the product is not delivered to customer.

RTO: Cancel RTO

A seller needs to cancel an RTO in case the product has been delivered to customer.

With this update, the forward product is to be confirmed as delivered and the delivery date is required as an input.

Completed

The returns that have been successfully closed by the sellers.

Can include completed customer returns, acknowledged courier returns, rejected customer returns and cancelled courier returns.

N.A.

Associated Actions

Cancel Courier Return

Return: Return Approved → Return Cancelled

Acknowledge Courier Return

Return: Return Approved → Return Completed

Return Tech Visit Attempt

Increase in SLA for tech visit completion

Return Tech visit complete and Return approval

Service: Service Requested → Service Completed

Return: Return Requested → Return Approved

Return Tech visit complete and Return rejected

Service: Service Requested → Service Cancelled

Return: Return Requested → Return Rejected

Reverse Pick up Attempt

Increase in SLA for reverse pick up

Reverse Pick up Complete

Return: Return Approved → Return Completed

Complete List of Order Management Pull APIs

Format: JSON

Protocol: HTTPS

API Description / Use Case Type
POST /orders/search Search orders based on dates, state, seller SKU ID, or orderItem ID Common
GET /orders/{orderItemId} Get order item details based on the orderItem ID Standard
GET /orders/ Get details for specified orderItemId and its sub-items Common
POST /orders/labels Mark orders as packed and generate labels Standard
GET /orders/labels?orderItemIds={id list} Print shipping labels Standard
POST /orders/dispatch Mark orders as “Ready to Dispatch” Standard
GET /orders/shipments?orderItemIds={id list} Get shipment information of order items Common
GET /orders/invoices Get invoice information of order items Common
POST /orders/cancel Cancel an approved order Common
GET /returns Get the details of order items returned Common
POST /shipments/dispatch Mark dispatch on Self Ship item Self Ship
POST /shipments/delivery Mark Self Ship item as delivered Self Ship
POST /shipments/deliveryAttempt Mark delivery attempt on Self Ship item Self Ship
POST /services/attempt Mark service attempt detail Self Ship
POST /services/complete Mark service as completed Self Ship
POST /returns/approve Approve Self Ship returns Self Ship
POST /returns/reject Reject Self Ship returns Self Ship
POST /returns/complete Acknowledge Self Ship RVP returns Self Ship
POST /returns/pickup Mark Self Ship retuns as picked up Self Ship
POST /returns/pickupAttempt Mark pickup attempt on Self Ship returns Self Ship