1 Triggers
- 1.1 1. New Orders
- 1.2 2. Order cancelled
- 1.3 3. New Returns
- 1.4 4. Packed Orders
2 Actions:
- 2.1 1. Update Inventory Count
- 2.2 2. Generate Shipping Label and Invoice
- 2.3 3. Mark Ready to Dispatch
- 2.4 4. Cancel Order API
3 Searches:
- 3.1 1. Get shipment details
- 3.2 2. Get Order Item Details
- 3.3 3. Get Listings

Triggers

1. New Orders

Noun: Orders

Description: Triggers when a new shipment is created against an order on Flipkart.

Trigger type: Polling

API URL: POST

https://api.flipkart.net/sellers/v3/shipments/filter

Request Body:

{
    "filter": {
        
        "states": [
            "APPROVED"
        ],
        "type": "preDispatch",
        "orderDate": {
        "to": "{{2020-10-01T19:36:09Z}}",
        "from": "{{2020-10-01T19:36:09Z}}"
        }
    }
}

Response:

{
    "hasMore": true,
    "nextPageUrl": "/v3/shipments/filter?next_token=ewogICJmaWx0ZXJUeXBlIiA6ICJwcmVEaXNwYXRjaCIsCiAgInNlbGxlcklkIiA6ICIyOGRiYTBkNTgwZjY0NzA4IiwKICAidG9rZW4iIDogImV3b2dJQ0p3WVhKaGJYTWlJRG9nZXdvZ0lDQWdJbVJwYzNCaGRHTm9YM1JwWlhKeklpQTZJRnNnSWxKRlIxVk1RVklpTENBaVJWaFFVa1ZUVXlJZ1hTd0tJQ0FnSUNKelpXeHNaWEpmYVdRaUlEb2dJakk0WkdKaE1HUTFPREJtTmpRM01EZ2lMQW9nSUNBZ0lteHZZMkYwYVc5dVgybGtJaUE2SUNKTVQwTTJNbUV6TUdNeFpERTFPVGcwTldVd09XUm1aV1ZtTXpBelpqVXlZMlppT1NJc0NpQWdJQ0FpYjNKa1pYSmZaR0YwWlNJZ09pQnVkV3hzTEFvZ0lDQWdJbVJwYzNCaGRHTm9YMko1WDJSaGRHVWlJRG9nYm5Wc2JDd0tJQ0FnSUNKa2FYTndZWFJqYUY5aFpuUmxjbDlrWVhSbElpQTZJRzUxYkd3c0NpQWdJQ0FpYzNSaGRHVnpJaUE2SUZzZ0luQmhlVzFsYm5SZllYQndjbTkyWldRaUlGMHNDaUFnSUNBaWMyaHBjRzFsYm5SZmRIbHdaWE1pSURvZ1d5QWlUazlTVFVGTUlpQmRMQW9nSUNBZ0ltMXZaR2xtYVdWa1gyUmhkR1VpSURvZ2JuVnNiQ3dLSUNBZ0lDSnpiM0owWDJacFpXeGtYekFpSURvZ0ltUnBjM0JoZEdOb1gySjVYMlJoZEdVaUxBb2dJQ0FnSW5OdmNuUmZiM0prWlhKZk1DSWdPaUFpWVhOaklpd0tJQ0FnSUNKbWNtOXRJaUE2SURBc0NpQWdJQ0FpYzJsNlpTSWdPaUF5TlFvZ0lIMHNDaUFnSW5CaFoybHVZWFJwYjI0aUlEb2dld29nSUNBZ0luQmhaMlZmYm5WdElpQTZJRElzQ2lBZ0lDQWljR0ZuWlY5emFYcGxJaUE2SURJd0NpQWdmU3dLSUNBaWMyOXlkQ0lnT2lCYklGMEtmUSIsCiAgInZpZXciIDogIm9yZGVyX2FwaS52My5zaGlwbWVudCIsCiAgInRlbXBsYXRlIiA6ICJvYXBpX3ByZV9kaXNwYXRjaCIKfQ",
    "shipments": [
        {
            "shipmentId": "cd6fff34-368e-44dd-b747-d7fad8c84990",
            "dispatchByDate": "2020-09-28T12:00:00.000+05:30",
            "dispatchAfterDate": "2020-09-27T12:01:00.000+05:30",
            "updatedAt": "2020-09-20T15:44:12.000+05:30",
            "locationId": "LOC62a30c1d159845e09dfeef303f52cfb9",
            "hold": false,
            "mps": false,
            "packagingPolicy": "DEFAULT",
            "subShipments": [
                {
                    "subShipmentId": "SS-1",
                    "packages": [
                        {
                            "packageId": "PKGBRFF8H6TSRBXPABQIUPJI5",
                            "packageSku": "BBAPLBB63792_L",
                            "dimensions": {
                                "length": 16,
                                "breadth": 12,
                                "height": 6,
                                "weight": 0.23
                            }
                        }
                    ]
                }
            ],
            "orderItems": [
                {
                    "orderItemId": "11974521229403000",
                    "orderId": "OD119745212294030000",
                    "cancellationGroupId": "grp11974521229403000",
                    "orderDate": "2020-09-20T15:43:49.000+05:30",
                    "paymentType": "COD",
                    "status": "APPROVED",
                    "quantity": 1,
                    "fsn": "BRFF8H6TSRBXPABQ",
                    "sku": "BBAPLBB63792_L",
                    "listingId": "LSTBRFF8H6TSRBXPABQIUPJI5",
                    "hsn": "61071100",
                    "title": "Blackberrys Men Brief L SP-INFLUENCE_Mustard",
                    "packageIds": [
                        "PKGBRFF8H6TSRBXPABQIUPJI5"
                    ],
                    "priceComponents": {
                        "sellingPrice": 416.0,
                        "totalPrice": 452.0,
                        "shippingCharge": 36.0,
                        "customerPrice": 452.0,
                        "flipkartDiscount": 0.0
                    },
                    "serviceProfile": "Seller_Fulfilment",
                    "is_replacement": false
                }
            ],
            "forms": [],
            "shipmentType": "NORMAL"
        }
        
    ]
}

2. Order cancelled

Noun: Orders

Description: Triggers when a new shipment is canceled on Flipkart.

Trigger type: Polling

API URL: POST

https://api.flipkart.net/sellers/v3/shipments/filter

Request Body:

{
    "filter": {
        
        "states": [
            "CANCELLED"
        ],
        
        "type": "cancelled",
        "cancellationType": "{{marketplaceCancellation}}",
        "cancellationDate": {
        "from" :"{{2020-10-01T19:36:09Z}}",
        "to": "{{2020-10-15T19:36:09Z}}"
        }
    },
    
}

Valid values for cancellationType are marketplaceCancellation, sellerCancellation and buyerCancellation.

Sample Response:

{
    "hasMore": true,
    "nextPageUrl": "/v3/shipments/filter?next_token=ewogICJmaWx0ZXJUeXBlIiA6ICJjYW5jZWxsZWQiLAogICJzZWxsZXJJZCIgOiAiMjhkYmEwZDU4MGY2NDcwOCIsCiAgInRva2VuIiA6ICJld29nSUNKd1lYSmhiWE1pSURvZ2V3b2dJQ0FnSW5ObGNuWnBZMlZmY0hKdlptbHNaWE1pSURvZ1d5QWlUazlPWDBaQ1JpSWdYU3dLSUNBZ0lDSmpZVzVqWld4c1pXUWlJRG9nZXdvZ0lDQWdJQ0FpY21WaGMyOXVjeUlnT2lCYklDSmpZVzVqWld4c1lYUnBiMjVmY21WeGRXVnpkR1ZrSWlCZENpQWdJQ0I5TEFvZ0lDQWdJbkowYnlJZ09pQjdDaUFnSUNBZ0lDSnlaV0Z6YjI1eklpQTZJRnNnSWxOSldrVmZSa2xVWDBsVFUxVkZVeUlzSUNKRFZWTlVUMDFGVWw5U1JVMVBVbE5GSWl3Z0lrTjFjM1J2YldWeUlFTmhibU5sYkd4bFpDQk9iM1FnU1c1MFpYSmxjM1JsWkNJc0lDSkpibU52YlhCc1pYUmxYMEZrWkhKbGMzTWlMQ0FpUVhSMFpXMXdkRjlGZUdoaGRYTjBaV1FpTENBaVVtVnFaV04wWldSZllubGZRM1Z6ZEc5dFpYSWlMQ0FpVFVsVFUwbE9SMTlKVkVWTklpd2dJa1JGUVVSZlQwNWZRVkpTU1ZaQlRDSXNJQ0p2Y21SbGNsOWpZVzVqWld4c1pXUWlMQ0FpVVZWQlRFbFVXVjlKVTFOVlJWTWlMQ0FpVW1WcVpXTjBaV1JmWW5sZlEzVnpkRzl0WlhKZlVHOXpkRTlDUkNJc0lDSkJkSFJsYlhCMGMxOUZlR2hoZFhOMFpXUWlMQ0FpVTJocGNHMWxiblJmVlc1aGRIUmxibVJsWkNJc0lDSnZjbVJsY2w5allXNWpaV3hzWVhScGIyNGlMQ0FpUTNWemRHOXRaWElnUTJGdVkyVnNiR0YwYVc5dUlDMGdUbTkwSUVsdWRHVnlaWE4wWldRdlVtVnFaV04wWldRaUxDQWlRMkZ1WTJWc2JHVmtJSFJvWlNCdmNtUmxjaUlzSUNKamRYTjBiMjFsY2w5allXNWpaV3hzWldSZmJtOTBYMmx1ZEdWeVpYTjBaV1FpTENBaVRVbFRVMGhKVUUxRlRsUWlMQ0FpVlc1a1pXeHBkbVZ5WldSZlVHbGphM1Z3WDFScGJXVmZSV3hoY0hObFpDSXNJQ0pFUlVaRlExUkpWa1ZmVUZKUFJGVkRWQ0lnWFFvZ0lDQWdmU3dLSUNBZ0lDSmpZVzVqWld4c1lYUnBiMjVmWkdGMFpTSWdPaUJ1ZFd4c0xBb2dJQ0FnSW1ScGMzQmhkR05vWDNScFpYSnpJaUE2SUZzZ0lsSkZSMVZNUVZJaUxDQWlSVmhRVWtWVFV5SWdYU3dLSUNBZ0lDSnpaV3hzWlhKZmFXUWlJRG9nSWpJNFpHSmhNR1ExT0RCbU5qUTNNRGdpTEFvZ0lDQWdJbTl5WkdWeVgyUmhkR1VpSURvZ2JuVnNiQ3dLSUNBZ0lDSmthWE53WVhSamFGOWllVjlrWVhSbElpQTZJRzUxYkd3c0NpQWdJQ0FpWkdsemNHRjBZMmhmWVdaMFpYSmZaR0YwWlNJZ09pQnVkV3hzTEFvZ0lDQWdJbk5vYVhCdFpXNTBYM1I1Y0dWeklpQTZJRnNnSWs1UFVrMUJUQ0lnWFN3S0lDQWdJQ0p0YjJScFptbGxaRjlrWVhSbElpQTZJRzUxYkd3c0NpQWdJQ0FpYzI5eWRGOW1hV1ZzWkY4d0lpQTZJQ0prYVhOd1lYUmphRjlpZVY5a1lYUmxJaXdLSUNBZ0lDSnpiM0owWDI5eVpHVnlYekFpSURvZ0ltRnpZeUlzQ2lBZ0lDQWlabkp2YlNJZ09pQXdMQW9nSUNBZ0luTnBlbVVpSURvZ01qVUtJQ0I5TEFvZ0lDSndZV2RwYm1GMGFXOXVJaUE2SUhzS0lDQWdJQ0p3WVdkbFgyNTFiU0lnT2lBeUxBb2dJQ0FnSW5CaFoyVmZjMmw2WlNJZ09pQXhDaUFnZlN3S0lDQWljMjl5ZENJZ09pQmJJRjBLZlEiLAogICJ2aWV3IiA6ICJvcmRlcl9hcGkudjMuY2FuY2VsbGVkIiwKICAidGVtcGxhdGUiIDogIm9hcGlfY2FuY2VsbGVkIgp9",
    "shipments": [
        {
            "shipmentId": "d04887a0-b8b6-4ff5-913b-b935e94fabab",
            "dispatchByDate": "2020-06-13T12:00:00.000+05:30",
            "dispatchAfterDate": "2020-06-11T18:01:00.000+05:30",
            "updatedAt": "2020-08-12T16:28:48.000+05:30",
            "hold": false,
            "mps": false,
            "subShipments": [
                {
                    "subShipmentId": "SS-1",
                    "packages": [
                        {
                            "packageId": "PKGDREFQ3E83PVCE7HNN1ZQQ1",
                            "packageSku": "13DB23FMFAW"
                        }
                    ]
                }
            ],
            "orderItems": [
                {
                    "orderItemId": "11886250452593500",
                    "orderId": "OD118862504525935000",
                    "cancellationGroupId": "grp11886250452593500",
                    "orderDate": "2020-06-10T11:46:10.000+05:30",
                    "cancellationDate": "2020-08-12T16:28:46.000+05:30",
                    "paymentType": "PREPAID",
                    "status": "CANCELLED",
                    "cancellationReason": "order_cancelled",
                    "cancellationSubReason": "delivery_time_long",
                    "courierReturn": true,
                    "quantity": 1,
                    "fsn": "DREFQ3E83PVCE7HN",
                    "sku": "13DB23FMFAW",
                    "listingId": "LSTDREFQ3E83PVCE7HNN1ZQQ1",
                    "hsn": "61044300",
                    "title": "Cover Story Women Maxi Yellow Dress L DSMX03UB0823-MU",
                    "packageIds": [
                        "PKGDREFQ3E83PVCE7HNN1ZQQ1"
                    ],
                    "priceComponents": {
                        "sellingPrice": 1.0,
                        "totalPrice": 42.0,
                        "shippingCharge": 41.0,
                        "customerPrice": 42.0,
                        "flipkartDiscount": 0.0
                    },
                    "serviceProfile": "Seller_Fulfilment",
                    "is_replacement": false
                }
            ],
            "shipmentType": "NORMAL"
        }
    ]
}

3. New Returns

Noun: Returns

Description: Triggers when a new return is created on Flipkart.

Trigger type: Polling

Refer to Flipkart Get Returns API.

API URL:

http://api.flipkart.net/sellers/v2/returns?source={{source_mode}&createdAfter={{2020-10-15T19:36:09Z}&locationId={{locationId}

source: valid values are customer_return, courier_return

Response:

{
    "hasMore": true,
    "nextUrl": "/returns/search/ewogICJmaWx0ZXIiIDogewogICAgInNlcnZpY2VfcHJvZmlsZSIgOiBudWxsLAogICAgInR5cGUiIDogWyAiY291cmllcl9yZXR1cm4iIF0sCiAgICAic2hpcG1lbnRfdHlwZXMiIDogbnVsbCwKICAgICJzaGlwbWVudF9zdGF0dXMiIDogbnVsbCwKICAgICJyZXR1cm5fc3RhdHVzIiA6IG51bGwsCiAgICAic2hpcG1lbnRfZXhwZWN0YXRpb25zIiA6IG51bGwsCiAgICAic2t1IiA6IG51bGwsCiAgICAicHJvbWlzZV9icmVhY2giIDogbnVsbCwKICAgICJhcHByb3ZlZCIgOiBudWxsLAogICAgInByb21pc2UiIDogbnVsbCwKICAgICJvdXRfZm9yX2RlbGl2ZXJ5IiA6IG51bGwsCiAgICAicmV0dXJuX2NvbXBsZXRlZCIgOiBudWxsLAogICAgInNoaXBtZW50X2NvbXBsZXRlZF9vbiIgOiBudWxsLAogICAgImNyZWF0ZWRfYWZ0ZXIiIDogbnVsbCwKICAgICJtb2RpZmllZF9hZnRlciIgOiBudWxsCiAgfSwKICAicGFnaW5hdGlvbiIgOiB7CiAgICAic3RhcnRpbmdfcGFnZSIgOiAyLAogICAgInBhZ2Vfc2l6ZSIgOiAyNQogIH0sCiAgInNvcnQiIDogbnVsbAp9",
    "returnItems": [
        {
            "orderItemId": "11980720411507700",
            "locationId": "LOC62a30c1d159845e09dfeef303f52cfb9",
            "orderId": "OD119807204115077000",
            "quantity": 1,
            "orderDate": "2020-09-27T14:25:48.659Z",
            "createdDate": "2020-09-28T16:19:17+05:30",
            "courierName": null,
            "sellerId": "28dba0d580f64708",
            "returnId": "10101981454721753372",
            "status": "created",
            "type": "courier_return",
            "reason": "order_cancelled",
            "subReason": "mind_changed",
            "trackingId": "FMPC0883440212",
            "shipmentStatus": "in_transit",
            "shipmentId": null,
            "comments": "",
            "updatedDate": null,
            "approvedOn": null,
            "expectedDate": "2020-10-28T16:19:30.000",
            "serviceProfile": "NON_FBF",
            "services": []
        }
    ]
}

return items status can be created, cancelled, and completed. Filter returns on the basis of status.

4. Packed Orders

Noun: Orders

Description: Triggers when a new shipment is created against an order on Flipkart.

Trigger type: Polling

API URL: POST

https://api.flipkart.net/sellers/v3/shipments/filter

Request Body:

{
    "filter": {
        
        "states": [
            "PACKED"
        ],
        "type": "preDispatch",
        "orderDate": {
        "to": "{{2020-10-01T19:36:09Z}}",
        "from": "{{2020-10-01T19:36:09Z}}"
        }
    }
}

Response:

{
    "hasMore": false,
    "nextPageUrl": "/v3/shipments/filter?next_token=ewogICJmaWx0ZXJUeXBlIiA6ICJwcmVEaXNwYXRjaCIsCiAgInNlbGxlcklkIiA6ICIyOGRiYTBkNTgwZjY0NzA4IiwKICAidG9rZW4iIDogbnVsbCwKICAidmlldyIgOiAib3JkZXJfYXBpLnYzLnNoaXBtZW50IiwKICAidGVtcGxhdGUiIDogIm9hcGlfcHJlX2Rpc3BhdGNoIgp9",
    "shipments": [
        {
            "shipmentId": "6714189e-2275-4deb-b7b8-1203b399ba22",
            "dispatchByDate": "2020-10-17T12:00:00.000+05:30",
            "dispatchAfterDate": "2020-10-14T01:02:20.000+05:30",
            "updatedAt": "2020-10-16T17:11:32.000+05:30",
            "locationId": "LOC62a30c1d159845e09dfeef303f52cfb9",
            "hold": false,
            "mps": false,
            "packagingPolicy": "DEFAULT",
            "subShipments": [
                {
                    "subShipmentId": "SS-1",
                    "packages": [
                        {
                            "packageId": "PKGFABFAYQ9GGZJT9MSNLEWJX",
                            "packageSku": "BBAPLLC67099",
                            "dimensions": {
                                "length": 22,
                                "breadth": 2.5,
                                "height": 25.5,
                                "weight": 0.28
                            }
                        }
                    ]
                }
            ],
            "orderItems": [
                {
                    "orderItemId": "21984176154574401",
                    "orderId": "OD219841761545744000",
                    "cancellationGroupId": "grp21984176154574401",
                    "orderDate": "2020-10-01T19:56:01.000+05:30",
                    "paymentType": "PREPAID",
                    "status": "PACKED",
                    "quantity": 1,
                    "fsn": "FABFAYQ9GGZJT9MS",
                    "sku": "BBAPLLC67099",
                    "listingId": "LSTFABFAYQ9GGZJT9MSNLEWJX",
                    "hsn": "5309",
                    "title": "Linen Club Linen Checkered Shirt Fabric AMZ-63",
                    "packageIds": [
                        "PKGFABFAYQ9GGZJT9MSNLEWJX"
                    ],
                    "priceComponents": {
                        "sellingPrice": 1344.0,
                        "totalPrice": 1344.0,
                        "shippingCharge": 0.0,
                        "customerPrice": 1344.0,
                        "flipkartDiscount": 0.0
                    },
                    "serviceProfile": "Seller_Fulfilment",
                    "is_replacement": true
                }
            ],
            "forms": [],
            "shipmentType": "NORMAL"
        }    
        ]
}

Actions:

1. Update Inventory Count

Noun: Inventory

Description: This action updates the inventory count in Flipkart when there is a change in the inventory in Eshopbox (addition/ removal)

Refer to Flipkart Update Inventory Endpoint.

API URL:

https://api.flipkart.net//listings/v3/update/inventory

Request Body

{
    "{{sku}}": {
        "product_id": "{{product_id}}",
        "locations": [
            {
                "id": "{{location-id}}",
                "inventory": {{1}}
            }
        ]
    }
}

Response Body/Event Structure:

200 OK Response

{
    "sku": {
        "status": "{{success}}",
        "errors": [
            {
                "severity": "{{ERROR}}",
                "code": "code",
                "description": "description"
            }
        ],
        "attribute_errors": [
            {
                "severity": "{{ERROR}}",
                "code": "code",
                "description": "description",
                "attribute": "attribute",
                "path": "path-to-attribute"
            }
        ]
    }
}

severity can be ERROR, WARNING

status can be success, failure, warning

2. 400 Bad Request

{
    "errors": [
        {
            "severity": "ERROR",
            "code": "400",
            "description": "<description>",
            "path": "<path-to-failed-json-node>"
        }
    ]
}

severity can be ERROR, WARNING

3. 500 Bad Request

{
    "errors": [
        {
            "severity": "ERROR",
            "code": "500",
            "description": "<description>"
        }
    ]
}

severity can be ERROR, WARNING

2. Generate Shipping Label and Invoice

Noun: orders

Description: Once the shipment is created in Eshopbox send a packaging in progress request to Flipkart, for that send a POST request to generate a shipping label.

Refer to Flipkart Label Generation API

API URL:

https://api.flipkart.net/sellers/v3/shipments/labels

Get labels Request Body JSON

{
  "shipments": [
    {
      "subShipments": [
        {
          "dimensions": {
            "breadth": {{33.274}],
            "length": {{33.274}},
            "weight": {{33.274}},
            "height": {{33.274}}
          },
          "subShipmentId": "{{SS-1}}"
        }
      ],
      "taxItems": [
        {
          "taxRate": {{0}},
          "orderItemId": "{{11994708058372100}}",
          "quantity": {{1}}
        }
      ],
      "invoices": [
        {
          "orderId": "{{OD119947080583721000}}",
          "invoiceDate": "{{2020-10-16}}"
        }
      ],
     
      "locationId": "{{LOC62a30c1d159845e09dfeef303f52cfb9}}",
      "shipmentId": "{{71c7dd09-2be6-4d79-923d-5fa74ec6c16b}}"
    }
  ]
}

Get labels Response Body JSON

{
    "shipments":[{
      "shipmentId":"71c7dd09-2be6-4d79-923d-5fa74ec6c16b",
      "processingStatus":"SUCCESS",
      "errorCode":"string",
      "errorMessage":"string",
  }],
  
}

Error Codes

Error Codes	Reason for Error

Error Codes	Reason for Error
`FF_ITEM_ON_HOLD`	Error if the shipment is on hold
`FF_INVALID_PACK_REQUEST`	If all the order items inside shipment are not in approved state
`FF_INCOMPLETE_SHIPMENT_DIMENSIONS`	Invalid dimensions are given for particular sub shipment
`SERVICIBILITY_NOT_ALLOWED`	Serviceability not allowed from seller location to buyer location
`FF_PACK_TIN_NOT_FOUND`	Seller TIN number not found
`FF_PACK_INVALID_DISPATCH_AFTER_DATE`	Dispatch After Date is greater than the current time of pack
`FF_PACK_OPERATION_NOT_AUTHORISED`	Seller not authorized for packing the shipment

3. Mark Ready to Dispatch

Noun: order

Description: Once the shipment is packed in Eshopbox mark the Ready to Dispatch event on Flipkart.

Refer to Flipkart Mark RTD API.

API URL:

https://api.flipkart.net/sellers/v3/shipments/dispatch

Request Body JSON

{
    "shipmentIds":"[{{71c7dd09-2be6-4d79-923d-5fa74ec6c16b}}]",
    "locationId" :"{{LOC62a30c1d159845e09dfeef303f52cfb9}}",
}

Response Body JSON

{
  "shipments":[{
      "shipmentId":"71c7dd09-2be6-4d79-923d-5fa74ec6c16b",
      "processingStatus":"SUCCESS",
      "errorCode":"string",
      "errorMessage":"string",
  }],
}

processingStatus can be SUCCESS or FAILURE

Error Codes

Error Codes	Reason for Error

Error Codes	Reason for Error
`DEPENDENT_SYSTEM_CALL_FAILED`	This error occurs if an internal system fails during v3/shipments/dispatch call

4. Cancel Order API

Noun: Order

Description: Cancels order on Flipkart.

Refer to Flipkart Cancel Order API.

API Url:

https://api.flipkart.net/sellers/v3/shipments/cancel

Request Body:

{
    "shipments": [
    {
        "shipmentId": "{{71c7dd09-2be6-4d79-923d-5fa74ec6c16b}}",
        "locationId": "{{LOC62a30c1d159845e09dfeef303f52cfb9}}",
        "cancellationGroupIds": "{{grp11994708058372100}}",
        "reason": "{{cannot_procure_item}}"
    }
    ]
}

Cancellation reason should be one of the below(cannot_procure_item, not_enough_inventory, b2b_order)

Error Codes	Reason for Error

Error Codes	Reason for Error
`EMPTY_OR_INVALID_REASON_FOR_CANCELLATION`	Cancellation reason is empty or invalid

Response body:

{
    "shipments":[
     {
        "shipmentId": "71c7dd09-2be6-4d79-923d-5fa74ec6c16b",
        "processingStatus": "SUCCESS",
        "errorCode": "",
        "errorMessage": ""
    }
    ]
}

processingStatus can be SUCCESS or FAILURE

Error Codes

Error Codes	Reason for Error

Error Codes	Reason for Error
`EMPTY_OR_INVALID_REASON_FOR_CANCELLATION`	Cancellation reason is empty or invalid

Searches:

1. Get shipment details

Noun: Order

Description: Get shipment details on the basis of shipment Id

To Get shipment details call Flipkart Get Shipment Information API.

API URL:

https://api.flipkart.net/sellers/v3/shipments/{{34cd0ce4-0d93-4b5f-85ea-213a66419ea9}}

Response Body/Event Structure

{
    "shipments": [
        {
            "orderId": "OD119926957425821000",
            "shipmentId": "34cd0ce4-0d93-4b5f-85ea-213a66419ea9",
            "orderItems": [
                {
                    "id": "11992695742582100",
                    "fragile": false,
                    "large": false,
                    "dangerous": false
                }
            ],
            "deliveryAddress": {
                "firstName": "Brilliant",
                "lastName": "Sangma",
                "pinCode": "794001",
                "city": "Tura",
                "state": "Meghalaya",
                "stateCode": "IN-ML",
                "addressLine1": "tura bar association",
                "addressLine2": "Tetengkol",
                "landmark": "deputy commissioner's office",
                "contactNumber": null
            },
            "billingAddress": {
                "firstName": "Brilliant",
                "lastName": "Sangma",
                "pinCode": "794001",
                "city": "Tura",
                "state": "Meghalaya",
                "stateCode": "IN-ML",
                "addressLine1": "tura bar association",
                "addressLine2": "Tetengkol",
                "landmark": "deputy commissioner's office",
                "contactNumber": null
            },
            "buyerDetails": {
                "firstName": "Brilliant",
                "lastName": "Sangma"
            },
            "sellerAddress": {
                "sellerName": "ESBRetail",
                "pinCode": "122506",
                "city": "GURGAON",
                "state": "HARYANA",
                "stateCode": null,
                "addressLine1": "Adani Logistics Park, ICD Patli,",
                "addressLine2": "Pataudi Rd, Gurugram, Haryana 122506",
                "landmark": null
            },
            "returnAddress": {
                "firstName": null,
                "lastName": null,
                "pinCode": null,
                "city": null,
                "state": null,
                "stateCode": null,
                "addressLine1": null,
                "addressLine2": null,
                "landmark": null,
                "contactNumber": null
            },
            "subShipments": [
                {
                    "subShipmentId": "SS-1",
                    "courierDetails": {
                        "pickupDetails": {
                            "trackingId": null,
                            "vendorName": null
                        },
                        "deliveryDetails": {
                            "trackingId": null,
                            "vendorName": null
                        }
                    },
                    "shipmentDimensions": {
                        "length": null,
                        "breadth": null,
                        "height": null,
                        "weight": null
                    }
                }
            ],
            "locationId": "LOC62a30c1d159845e09dfeef303f52cfb9"
        }
    ]
}

Error Codes

Error Codes	Reason for Error

Error Codes	Reason for Error
`DEPENDENT_SYSTEM_CALL_FAILED`	Error in getting shipment details for the shipment

2. Get Order Item Details

Noun: Order

Description: Get shipment details on the basis of order Item Id

To get shipment details by order ids call Flipkart Get by orderIds API.

API URL:

https://api.flipkart.net/sellers/v3/shipments?orderIds={{OD119926957425821000}}

Get Order Items Response Body JSON

{
    "shipments": [
        {
            "shipmentId": "34cd0ce4-0d93-4b5f-85ea-213a66419ea9",
            "dispatchByDate": "2020-10-17T12:00:00.000+05:30",
            "dispatchAfterDate": "2020-10-16T14:01:00.000+05:30",
            "updatedAt": "2020-10-11T16:35:47.000+05:30",
            "locationId": "LOC62a30c1d159845e09dfeef303f52cfb9",
            "hold": false,
            "mps": false,
            "packagingPolicy": "DEFAULT",
            "subShipments": [
                {
                    "subShipmentId": "SS-1",
                    "packages": [
                        {
                            "packageId": "PKGSHTFEE7M8VW2SGYXLIFCNF",
                            "packageSku": "BBAPLBB91748_38",
                            "dimensions": {
                                "length": 37.3,
                                "breadth": 28.7,
                                "height": 1.8,
                                "weight": 0.4
                            }
                        }
                    ]
                }
            ],
            "orderItems": [
                {
                    "orderItemId": "11992695742582100",
                    "orderId": "OD119926957425821000",
                    "cancellationGroupId": "grp11992695742582100",
                    "orderDate": "2020-10-11T16:34:41.000+05:30",
                    "paymentType": "COD",
                    "status": "APPROVED",
                    "quantity": 1,
                    "fsn": "SHTFEE7M8VW2SGYX",
                    "sku": "BBAPLBB91748_38",
                    "listingId": "LSTSHTFEE7M8VW2SGYXLIFCNF",
                    "hsn": "62059090",
                    "title": "Blackberrys Men Checkered Formal Pink Shirt 38 BP-CHFK24",
                    "packageIds": [
                        "PKGSHTFEE7M8VW2SGYXLIFCNF"
                    ],
                    "priceComponents": {
                        "sellingPrice": 1437.00,
                        "totalPrice": 1437.00,
                        "shippingCharge": 0.00,
                        "customerPrice": 1437.00,
                        "flipkartDiscount": 0.00
                    },
                    "serviceProfile": "Seller_Fulfilment",
                    "is_replacement": false
                }
            ],
            "forms": [],
            "shipmentType": "NORMAL"
        }
    ]
}

Error Codes

Error Codes	Reason for Error

Error Codes	Reason for Error
`DEPENDENT_SYSTEM_CALL_FAILED`	Error in getting forms for the shipment

3. Get Listings

Noun: Listing

Description: Get the information listed against the provided SKU Ids.

Refer to Flipkart Get Listing API

API URL:

https://api.flipkart.net/sellers/listings/v3/{sku-ids}

sku-ids is a Comma-separated list of SKU Ids. Maximum per call is10

Get Listing Response Body JSON

200 Response:

    "available": {
        "sku": {
            "listing_id": "<flipkart-system-identifier>",
            "product_id": "<flipkart-product-identifier>",
            "price": {
                "mrp": 0,
                "flipkart_selling_price": 0,
                "currency": "INR"
            },
            "tax": {
                "hsn": "<hsn-code>",
                "tax_code" : "<tax-code>"
            },
            "listing_status": "ACTIVE|INACTIVE",
            "shipping_fees": {
                "local": 0,
                "zonal": 0,
                "national": 0,
                "currency": "INR"
            },
            "marketplace": "FLIPKART",
            "fulfillment_profile": "NON_FBF|FBF_LITE|FBF",
            "fulfillment": {
                "dispatch_sla": 1,
                "shipping_provider": "FLIPKART|SELLER|FLIPKART_SELLER",
                "forbid_shipping": "NATIONAL|ZONAL|LOCAL",
                "procurement_type": "REGULAR|EXPRESS|INTERNATIONAL|MADE_TO_ORDER|DOMESTIC"
            },
            "packages": [
                {
                    "id": "<flipkart-system-identifier>",
                    "name": "<name>",
                    "dimensions": {
                        "length": 1,
                        "breadth": 1,
                        "height": 1
                    },
                    "weight": 1,
                    "description": "<description>",
                    "handling": {
                        "fragile": true
                    },
                    "notional_value": {
                        "amount": 1,
                        "unit": "PERCENTAGE|<CURRENCY>"
                    }
                }
            ],
            "locations": [
                {
                    "id": "<location-id>",
                    "status": "ENABLED|DISABLED",
                    "inventory": 0
                }
            ],
            "address_label": {
                "manufacturer_details": [
                    "<address_of_manufacturer>"
                ],
                "importer_details": [
                    "<address_of_importer>"
                ],
                "packer_details": [
                    "<address_of_packer>"
                ],
                "countries_of_origin": [
                    "<iso_alpha2_code_of_country_of_origin>"
                ]
            },
            "dating_label": {
                "mfg_date": "<Manufacturing date of the product in linux EPOCH (Seconds)>",
                "shelf_life": "<Shelf life of the product in Seconds>",
                "expiry_date": "<Expiry date of the product in linux EPOCH (Seconds)>"
            }
        },
        "orders_to_be_fulfilled": 0
    },
    "unavailable": [
        "<sku1>",
        "<sku2>"
    ],
    "invalid": [
        "<sku>"
    ]
}

400 Bad Request

{
    "errors": [
        {
            "severity": "ERROR|WARNING",
            "code": "<code>",
            "description": "<description>",
            "path": "<path-to-failed-json-node>"
        }
    ]
}

500 Bad Request

{
    "errors": [
        {
            "severity": "ERROR|WARNING",
            "code": "<code>",
            "description": "<description>"
        }
    ]
}

Apps and Automations

Flipkart App (API'S)

Triggers

1. New Orders

2. Order cancelled

3. New Returns

4. Packed Orders

Actions:

1. Update Inventory Count

2. Generate Shipping Label and Invoice

3. Mark Ready to Dispatch

4. Cancel Order API

Searches:

1. Get shipment details

2. Get Order Item Details

3. Get Listings

Related content