---
agentTools:
  projectIndex: https://sellerapis.snapdeal.com/llms.txt
---

# /suborders/cancelled

This api will returns the  orders in cancelled state

[block:callout]
{
  "type": "info",
  "title": "Note",
  "body": "Allowed fulfillment modes are VENDOR_SELF,ONESHIP,OCPLUS,DROPSHIP,FC_VOI.\nDefault pageSize=10\nDefault pageNumber=1\nDefault duration = 7 days (past 7 days from now)\nMax allowed date range is 7 days."
}
[/block]

[block:html]
{
  "html": "<div></div>\n<h4>Request</h4>\n<style></style>"
}
[/block]

[block:parameters]
{
  "data": {
    "h-0": "ParameterName",
    "h-1": "DataType",
    "h-2": "ParameterType",
    "h-3": "Requirement",
    "h-4": "Description",
    "0-0": "fModes",
    "0-4": "Comma separated fulfilment modes.",
    "0-1": "String",
    "0-2": "Query",
    "0-3": "Mandatory",
    "1-4": "pageNumber used for pagination",
    "2-4": "pageSize used for pagination",
    "1-3": "Optional",
    "2-3": "Optional",
    "1-2": "Query",
    "2-2": "Query",
    "1-1": "int",
    "2-1": "int",
    "1-0": "pageNumber",
    "2-0": "pageSize",
    "3-0": "startDate",
    "4-0": "endDate",
    "3-3": "Optional",
    "4-4": "endDate in epoch millisecond format",
    "3-4": "startDate in epoch millisecond format",
    "3-1": "long",
    "4-1": "long",
    "3-2": "Query",
    "4-2": "Query",
    "4-3": "Optional"
  },
  "cols": 5,
  "rows": 5
}
[/block]

[block:html]
{
  "html": "<div></div>\n<h4>Response</h4>\n<style></style>"
}
[/block]

metadata :

[block:parameters]
{
  "data": {
    "h-0": "FieldName",
    "h-1": "DataType",
    "h-2": "Description",
    "0-0": "requestId",
    "0-2": "Unique ID for the request",
    "1-0": "clientId",
    "1-2": "Partner Id",
    "2-0": "responseTime",
    "2-2": "Response Time",
    "3-0": "requestedURI",
    "3-2": "Requested URI",
    "4-0": "message",
    "4-2": "Error message",
    "0-1": "String",
    "1-1": "String",
    "3-1": "String",
    "4-1": "String",
    "2-1": "Long"
  },
  "cols": 3,
  "rows": 5
}
[/block]

payload :

[block:parameters]
{
  "data": {
    "h-0": "FieldName",
    "h-1": "DataType",
    "h-2": "Description",
    "0-0": "items",
    "0-1": "List<SellerItem>",
    "0-2": "items"
  },
  "cols": 3,
  "rows": 1
}
[/block]

SellerItem :

[block:parameters]
{
  "data": {
    "h-0": "FieldName",
    "h-1": "DataType",
    "h-2": "Description",
    "0-0": "suborderCode",
    "0-2": "suborderCode",
    "1-0": "orderDate",
    "1-2": "orderDate",
    "2-0": "productName",
    "2-2": "productName",
    "3-0": "serializable",
    "3-2": "serializable",
    "4-0": "serializedUniqueId",
    "4-2": "serializedUniqueId",
    "5-0": "attributes",
    "5-2": "attributes",
    "5-1": "String",
    "4-1": "String",
    "3-1": "String",
    "2-1": "String",
    "0-1": "String",
    "1-1": "Date",
    "6-0": "imageUrl",
    "6-2": "imageUrl",
    "6-1": "String",
    "7-0": "freebies",
    "7-2": "freebies",
    "7-1": "String",
    "8-0": "incentive",
    "8-2": "incentive",
    "8-1": "Boolean",
    "9-0": "price",
    "9-2": "price",
    "9-1": "Integer",
    "10-0": "mrp",
    "10-2": "mrp",
    "10-1": "Integer",
    "11-0": "siStatusCode",
    "11-2": "siStatusCode",
    "12-0": "updated",
    "12-2": "updated Date",
    "12-1": "Date",
    "11-1": "String",
    "13-0": "paymentMode",
    "13-2": "paymentMode",
    "14-0": "supc",
    "14-2": "supc",
    "15-0": "fulfillmentModelCode",
    "15-2": "fulfillmentModelCode",
    "15-1": "String",
    "13-1": "String",
    "14-1": "String",
    "16-0": "skuCode",
    "16-2": "skuCode",
    "17-0": "siReferenceCode",
    "17-2": "siReferenceCode",
    "18-0": "customerName",
    "18-2": "customerName",
    "19-0": "customerDetail",
    "19-2": "customerDetail",
    "20-0": "deliveryMode",
    "20-2": "deliveryMode",
    "16-1": "String",
    "17-1": "String",
    "18-1": "String",
    "20-1": "String",
    "19-1": "ShippingDetail",
    "21-0": "orderCode",
    "21-2": "Buyer orderCode",
    "21-1": "String",
    "22-0": "packageReferenceCode",
    "22-2": "packageReferenceCode",
    "22-1": "String",
    "23-0": "cancellationReason",
    "23-1": "String",
    "23-2": "cancellationReason"
  },
  "cols": 3,
  "rows": 24
}
[/block]

ShippingDetail :

[block:parameters]
{
  "data": {
    "0-0": "pincode",
    "0-2": "pincode",
    "1-0": "city",
    "1-2": "city",
    "2-0": "area",
    "2-2": "area",
    "3-0": "subArea",
    "3-2": "subArea",
    "0-1": "String",
    "1-1": "String",
    "2-1": "String",
    "3-1": "String",
    "4-0": "state",
    "5-0": "mobile",
    "6-0": "email",
    "4-1": "String",
    "5-1": "String",
    "6-1": "String",
    "4-2": "state",
    "5-2": "mobile number",
    "6-2": "email"
  },
  "cols": 3,
  "rows": 7
}
[/block]

[block:html]
{
  "html": "<div class=\"threes-nav\"><a href=\"http://sandbox-sellerapi.snapdeal.com/apidocs/index.html#!/Order_Management/getCancelledSubOrders_0\" target=\"_blank\" class=\"btn btn-default\"><div class=\"fa fa-compass fa-right\"></div>Test in the&nbsp;<strong>API Explorer</strong></a></div>"
}
[/block]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "API Settings",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "http://staging-apigateway.snapdeal.com/seller-api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "X-Auth-Token",
        "in": "header",
        "x-default": ""
      },
      "sec1": {
        "type": "apiKey",
        "name": "clientId",
        "in": "header",
        "x-default": "SellerAPITesting"
      },
      "sec2": {
        "type": "apiKey",
        "name": "x-seller-authz-token",
        "in": "header",
        "x-default": ""
      }
    }
  },
  "security": [
    {
      "sec0": [],
      "sec1": [],
      "sec2": []
    }
  ],
  "paths": {
    "/suborders/cancelled": {
      "get": {
        "summary": "/suborders/cancelled",
        "description": "This api will returns the  orders in cancelled state",
        "operationId": "suborderscancelled",
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"metadata\": {\n    \"requestId\": \"403e5bc9-f357-42aa-8f3e-362ebf0cc191\",\n    \"clientId\": \"partnerId\",\n    \"responseTime\": 767,\n    \"requestedURI\": \"GET /suborders/cancelled\"\n  },\n  \"payload\": {\n    \"items\": [\n      {\n        \"suborderCode\": \"41842806\",\n        \"orderDate\": 1457000066000,\n        \"productName\": \"HP Pen Drive \",\n        \"serializable\": \"\",\n        \"attributes\": \"Size - 5\\\" , Color - Black\",\n        \"imageUrl\": \"http://i4.sdlcdn.com/img/product/main/SDL088320531_1369201900_image1.jpg\",\n        \"freebies\": \"\",\n        \"price\": 32200,\n        \"siStatusCode\": \"OOS\",\n        \"updated\": 1457094703000,\n        \"paymentMode\": \"COD\",\n        \"supc\": \"SDL088320531\",\n        \"fulfillmentModelCode\": \"DROPSHIP_MODEL\",\n        \"skuCode\": \"SMD-13-05-22-09\",\n        \"siReferenceCode\": \"SI915376\",\n        \"customerName\": \"neha madan\",\n             \"customerDetail\": {\n              \"pincode\": \"560021\",\n              \"city\": \"Bangalore\",\n              \"area\": \"Delhi\",\n              \"subArea\": \"Okhla Phase 3\\n#246, 1st Floor\",\n              \"state\": \"Karnataka\",\n              \"mobile\": \"995366077\",\n              \"email\": \"alok.sinha@jasperindia.com\"\n            },\n            \"orderCode\": \"37690465\",\n            \"deliveryMode\": \"STANDARD\",\n            \"packageReferenceCode\": \"SLP891519\",\n            \"cancellationReason\": \"OOS\"\n      }\n    ]\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "metadata": {
                      "type": "object",
                      "properties": {
                        "requestId": {
                          "type": "string",
                          "example": "403e5bc9-f357-42aa-8f3e-362ebf0cc191"
                        },
                        "clientId": {
                          "type": "string",
                          "example": "partnerId"
                        },
                        "responseTime": {
                          "type": "integer",
                          "example": 767,
                          "default": 0
                        },
                        "requestedURI": {
                          "type": "string",
                          "example": "GET /suborders/cancelled"
                        }
                      }
                    },
                    "payload": {
                      "type": "object",
                      "properties": {
                        "items": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "suborderCode": {
                                "type": "string",
                                "example": "41842806"
                              },
                              "orderDate": {
                                "type": "integer",
                                "example": 1457000066000,
                                "default": 0
                              },
                              "productName": {
                                "type": "string",
                                "example": "HP Pen Drive "
                              },
                              "serializable": {
                                "type": "string",
                                "example": ""
                              },
                              "attributes": {
                                "type": "string",
                                "example": "Size - 5\" , Color - Black"
                              },
                              "imageUrl": {
                                "type": "string",
                                "example": "http://i4.sdlcdn.com/img/product/main/SDL088320531_1369201900_image1.jpg"
                              },
                              "freebies": {
                                "type": "string",
                                "example": ""
                              },
                              "price": {
                                "type": "integer",
                                "example": 32200,
                                "default": 0
                              },
                              "siStatusCode": {
                                "type": "string",
                                "example": "OOS"
                              },
                              "updated": {
                                "type": "integer",
                                "example": 1457094703000,
                                "default": 0
                              },
                              "paymentMode": {
                                "type": "string",
                                "example": "COD"
                              },
                              "supc": {
                                "type": "string",
                                "example": "SDL088320531"
                              },
                              "fulfillmentModelCode": {
                                "type": "string",
                                "example": "DROPSHIP_MODEL"
                              },
                              "skuCode": {
                                "type": "string",
                                "example": "SMD-13-05-22-09"
                              },
                              "siReferenceCode": {
                                "type": "string",
                                "example": "SI915376"
                              },
                              "customerName": {
                                "type": "string",
                                "example": "neha madan"
                              },
                              "customerDetail": {
                                "type": "object",
                                "properties": {
                                  "pincode": {
                                    "type": "string",
                                    "example": "560021"
                                  },
                                  "city": {
                                    "type": "string",
                                    "example": "Bangalore"
                                  },
                                  "area": {
                                    "type": "string",
                                    "example": "Delhi"
                                  },
                                  "subArea": {
                                    "type": "string",
                                    "example": "Okhla Phase 3\n#246, 1st Floor"
                                  },
                                  "state": {
                                    "type": "string",
                                    "example": "Karnataka"
                                  },
                                  "mobile": {
                                    "type": "string",
                                    "example": "995366077"
                                  },
                                  "email": {
                                    "type": "string",
                                    "example": "alok.sinha@jasperindia.com"
                                  }
                                }
                              },
                              "orderCode": {
                                "type": "string",
                                "example": "37690465"
                              },
                              "deliveryMode": {
                                "type": "string",
                                "example": "STANDARD"
                              },
                              "packageReferenceCode": {
                                "type": "string",
                                "example": "SLP891519"
                              },
                              "cancellationReason": {
                                "type": "string",
                                "example": "OOS"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"metadata\": {\n    \"requestId\": \"a30a443e-820d-45d5-b8bd-3b8ef83457bb\",\n    \"clientId\": \"partnerId\",\n    \"message\": \"Page number should be greater than 0\",\n    \"responseTime\": 30,\n    \"requestedURI\": \"GET /suborders/cancelled\"\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "metadata": {
                      "type": "object",
                      "properties": {
                        "requestId": {
                          "type": "string",
                          "example": "a30a443e-820d-45d5-b8bd-3b8ef83457bb"
                        },
                        "clientId": {
                          "type": "string",
                          "example": "partnerId"
                        },
                        "message": {
                          "type": "string",
                          "example": "Page number should be greater than 0"
                        },
                        "responseTime": {
                          "type": "integer",
                          "example": 30,
                          "default": 0
                        },
                        "requestedURI": {
                          "type": "string",
                          "example": "GET /suborders/cancelled"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "420": {
            "description": "420",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"metadata\": {\n    \"requestId\": \"a30a443e-820d-45d5-b8bd-3b8ef83457bb\",\n    \"clientId\": \"partnerId\",\n    \"message\": \"\",\n    \"responseTime\": 30,\n    \"requestedURI\": \"GET /suborders/cancelled\"\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "metadata": {
                      "type": "object",
                      "properties": {
                        "requestId": {
                          "type": "string",
                          "example": "a30a443e-820d-45d5-b8bd-3b8ef83457bb"
                        },
                        "clientId": {
                          "type": "string",
                          "example": "partnerId"
                        },
                        "message": {
                          "type": "string",
                          "example": ""
                        },
                        "responseTime": {
                          "type": "integer",
                          "example": 30,
                          "default": 0
                        },
                        "requestedURI": {
                          "type": "string",
                          "example": "GET /suborders/cancelled"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "630541309807941f67a93276:5b576c4ac6af890003de64d5"
}
```