Skip to main content
GET
/
orders
List Orders
curl --request GET \
  --url https://api.loopreturns.com/api/v1/orders \
  --header 'X-Authorization: <api-key>'
{
  "orders": [
    {
      "id": 2,
      "external_id": "<string>",
      "name": "<string>",
      "source": "<string>",
      "channel": {
        "id": 123,
        "name": "<string>"
      },
      "customer": {
        "id": 123,
        "external_id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "phone": "<string>"
      },
      "status": "active",
      "shipping_address": {
        "address1": "<string>",
        "city": "<string>",
        "country_code": "<string>",
        "name": "<string>",
        "company": "<string>",
        "address2": "<string>",
        "region": "<string>",
        "postal_code": "<string>"
      },
      "billing_address": {
        "address1": "<string>",
        "city": "<string>",
        "country_code": "<string>",
        "name": "<string>",
        "company": "<string>",
        "address2": "<string>",
        "region": "<string>",
        "postal_code": "<string>"
      },
      "taxes_included": true,
      "total_price": {
        "amount": 123,
        "currency_code": "USD"
      },
      "total_price_presentment": {
        "amount": 123,
        "currency_code": "USD"
      },
      "total_discounts": {
        "amount": 123,
        "currency_code": "USD"
      },
      "total_discounts_presentment": {
        "amount": 123,
        "currency_code": "USD"
      },
      "shipping_lines": [
        {
          "title": "<string>",
          "price": {
            "amount": 123,
            "currency_code": "USD"
          },
          "discounts": {
            "external_id": "<string>",
            "name": "<string>",
            "discount_type": "amount",
            "code": "<string>",
            "reason": "<string>",
            "rate": 123,
            "net_adjustment_money": {
              "amount": 123,
              "currency_code": "USD"
            },
            "tax_adjustment_money": {
              "amount": 123,
              "currency_code": "USD"
            }
          },
          "tax_lines": [
            {
              "title": "<string>",
              "rate": 123,
              "price": {
                "amount": 123,
                "currency_code": "USD"
              }
            }
          ]
        }
      ],
      "order_discounts": [
        {
          "external_id": "<string>",
          "name": "<string>",
          "discount_type": "amount",
          "code": "<string>",
          "reason": "<string>",
          "rate": 123,
          "tax_adjustment_money": {
            "amount": 123,
            "currency_code": "USD"
          },
          "net_adjustment_money": {
            "amount": 123,
            "currency_code": "USD"
          }
        }
      ],
      "total_taxes": {
        "amount": 123,
        "currency_code": "USD"
      },
      "total_taxes_presentment": {
        "amount": 123,
        "currency_code": "USD"
      },
      "tags": [
        "<string>"
      ],
      "refunds": [
        [
          [
            {
              "external_id": "<string>",
              "type": "line_item",
              "amount": {
                "amount": 123,
                "currency_code": "USD"
              },
              "line_item": [
                {
                  "id": 123,
                  "quantity": 123,
                  "restock": true
                }
              ],
              "created_at": "2023-04-25T13:25:00-05:00",
              "updated_at": "2023-04-25T13:25:00-05:00"
            }
          ]
        ]
      ],
      "line_items": [
        {
          "id": 2,
          "external_id": "<string>",
          "product": {
            "id": 123
          },
          "product_variant": {
            "id": 123
          },
          "quantity": 123,
          "unit_price": {
            "amount": 123,
            "currency_code": "USD"
          },
          "unit_price_presentment": {
            "amount": 50000,
            "currency_code": "USD"
          },
          "unit_discounts": {
            "amount": 50000,
            "currency_code": "USD"
          },
          "unit_discounts_presentment": {
            "amount": 50000,
            "currency_code": "USD"
          },
          "taxable": true,
          "tax_lines": [
            {
              "title": "<string>",
              "rate": 123,
              "price": {
                "amount": 123,
                "currency_code": "USD"
              }
            }
          ],
          "refunds": [
            {
              "external_id": "<string>",
              "type": "line_item",
              "amount": {
                "amount": 123,
                "currency_code": "USD"
              },
              "line_item": [
                {
                  "id": 123,
                  "quantity": 123,
                  "restock": true
                }
              ],
              "created_at": "2023-04-25T13:25:00-05:00",
              "updated_at": "2023-04-25T13:25:00-05:00"
            }
          ],
          "discounts": [
            {
              "external_id": "<string>",
              "discount_type": "amount",
              "discount_relation": "prereq",
              "name": "<string>",
              "code": "<string>",
              "reason": "<string>",
              "rate": 123,
              "tax_adjustment_money": {
                "amount": 123,
                "currency_code": "USD"
              },
              "net_adjustment_money": {
                "amount": 123,
                "currency_code": "USD"
              }
            }
          ],
          "duties": [
            {
              "hs_code": "<string>",
              "country_of_origin": "<string>",
              "price": {
                "amount": 123,
                "currency_code": "USD"
              },
              "tax_lines": [
                {
                  "title": "<string>",
                  "rate": 123,
                  "price": {
                    "amount": 123,
                    "currency_code": "USD"
                  }
                }
              ]
            }
          ]
        }
      ],
      "fulfillments": [
        {
          "external_id": "<string>",
          "status": "success",
          "fulfilled_at": "2023-11-07T05:31:56Z",
          "shipping_carrier": "<string>",
          "location": {
            "id": 123
          },
          "fulfillment_line_items": [
            {
              "external_id": "<string>",
              "order_line_item_external_id": "<string>",
              "quantity": 123
            }
          ],
          "tracking_numbers": [
            "<string>"
          ]
        }
      ],
      "created_at": "2023-04-25T13:25:00-05:00",
      "updated_at": "2023-04-25T13:25:00-05:00"
    }
  ],
  "next_page_url": "<string>",
  "previous_page_url": "<string>"
}

Authorizations

X-Authorization
string
header
required

API Scope: "Order (read)"

Query Parameters

sort_order
enum<string>
default:asc
Available options:
asc,
desc
limit
integer
default:50

Per page limit of results.

Required range: 1 <= x <= 250
cursor
string
external_id
string

Response

OK

orders
OrderResponse · object[]
next_page_url
string
previous_page_url
string