API Version 2
  • API V2 Overview
  • Category
    • Company
      • Customers
        • Orders
          • Pages
            • Page Templates
              • Products
                • Purchase Orders
                  • SKUs
                    • Support Tickets
                      • Tax Regions
                        • Vendors
                          • Warehouses
                            API Documentation

                            orders/info_returns

                            Type Info
                            List Orders
                            URL http://{domain}/api/v2/orders/info_returns.json
                            Accepts Filters No
                            Output Attributes
                            No


                            Orders Info Returns Data

                            Gets Order Returns info.
                            Filters
                            Filter the Orders Returns into a list.
                            Parameter Type Rules Example
                            id int / array one id or multiple Lead Commerce order ids
                            1 or array(3,8,9,45)
                            Status of Orders

                            See Order Fulfillment Status section Order Status for status outputs.


                            Response

                            Example JSON returned
                            {
                              "code": "200",
                              "data": {
                                "2": [
                                  {
                                    "id": "1",
                                    "rma": "R1",
                                    "line_items": "1",
                                    "total_items": "2",
                                    "rma_value": "45.98",
                                    "restocking_fee": "0.00",
                                    "notes": "Here are some RMA notes.",
                                    "status": "6",
                                    "warehouse": [
                                      {
                                        "id": "1",
                                        "name": "San Diego"
                                      }
                                    ],
                                    "items": [
                                      {
                                        "id": "1",
                                        "qty": "2",
                                        "sku": "450-0001-1",
                                        "restock": "0",
                                        "product": [
                                          {
                                            "id": "1",
                                            "display_id": "450",
                                            "name": "Modern-Fit Vest"
                                          }
                                        ],
                                        "reason": [
                                          {
                                            "id": "5",
                                            "name": "Damaged During Shipping"
                                          }
                                        ]
                                      }
                                    ]
                                  },
                                  {
                                    "id": "2",
                                    "rma": "R2",
                                    "line_items": "1",
                                    "total_items": "1",
                                    "rma_value": "",
                                    "restocking_fee": "0.00",
                                    "notes": "Here are some more notes.",
                                    "status": "8",
                                    "warehouse": [
                                      {
                                        "id": "1",
                                        "name": "San Diego"
                                      }
                                    ],
                                    "items": [
                                      {
                                        "id": "2",
                                        "qty": "1",
                                        "sku": "451-0001-1",
                                        "restock": "0",
                                        "product": [
                                          {
                                            "id": "2",
                                            "display_id": "451",
                                            "name": "Fleece Curved Pocket Hoodie"
                                          }
                                        ],
                                        "reason": [
                                          {
                                            "id": "4",
                                            "name": "Defective"
                                          }
                                        ]
                                      }
                                    ]
                                  }
                                ],
                                "3": [
                                  {
                                    "id": "3",
                                    "rma": "R3",
                                    "line_items": "4",
                                    "total_items": "7",
                                    "rma_value": "190.93",
                                    "restocking_fee": "0.00",
                                    "notes": "Here are some more RMA notes.",
                                    "status": "6",
                                    "warehouse": [
                                      {
                                        "id": "1",
                                        "name": "San Diego"
                                      }
                                    ],
                                    "items": [
                                      {
                                        "id": "1",
                                        "qty": "2",
                                        "sku": "450-0004-1",
                                        "restock": "0",
                                        "product": [
                                          {
                                            "id": "1",
                                            "display_id": "450",
                                            "name": "Modern-Fit Vest"
                                          }
                                        ],
                                        "reason": [
                                          {
                                            "id": "5",
                                            "name": "Damaged During Shipping"
                                          }
                                        ]
                                      },
                                      {
                                        "id": "2",
                                        "qty": "2",
                                        "sku": "450-0005-1",
                                        "restock": "0",
                                        "product": [
                                          {
                                            "id": "1",
                                            "display_id": "450",
                                            "name": "Modern-Fit Vest"
                                          }
                                        ],
                                        "reason": [
                                          {
                                            "id": "5",
                                            "name": "Damaged During Shipping"
                                          }
                                        ]
                                      },
                                      {
                                        "id": "3",
                                        "qty": "2",
                                        "sku": "451-0005-1",
                                        "restock": "0",
                                        "product": [
                                          {
                                            "id": "2",
                                            "display_id": "451",
                                            "name": "Fleece Curved Pocket Hoodie"
                                          }
                                        ],
                                        "reason": [
                                          {
                                            "id": "5",
                                            "name": "Damaged During Shipping"
                                          }
                                        ]
                                      },
                                      {
                                        "id": "4",
                                        "qty": "1",
                                        "sku": "451-0006-1",
                                        "restock": "0",
                                        "product": [
                                          {
                                            "id": "2",
                                            "display_id": "451",
                                            "name": "Fleece Curved Pocket Hoodie"
                                          }
                                        ],
                                        "reason": [
                                          {
                                            "id": "5",
                                            "name": "Damaged During Shipping"
                                          }
                                        ]
                                      }
                                    ]
                                  }
                                ]
                              }
                            }
                            

                            Start your free, no-risk trial today.