---
updatedAt: 2026-06-01T11:37:15.000Z
agentTools:
  projectIndex: https://docs.gifq.com/llms.txt
---

# List all orders

Returns a list of all orders

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "GIFQ External API Reference",
    "version": "v1",
    "description": "Public API documentation for GIFQ external partners."
  },
  "components": {
    "securitySchemes": {
      "X-Api-Token": {
        "type": "apiKey",
        "name": "X-Api-Token",
        "in": "header",
        "description": "API token for authentication"
      }
    }
  },
  "paths": {
    "/api/orders": {
      "get": {
        "summary": "List all orders",
        "tags": [
          "Orders"
        ],
        "description": "Returns a list of all orders",
        "security": [
          {
            "X-Api-Token": []
          }
        ],
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "schema": {
              "default": 1,
              "type": "integer"
            },
            "required": true,
            "description": "Page number. Defaults to 1. Needs to be present in order to query all orders."
          }
        ],
        "responses": {
          "200": {
            "description": "success",
            "headers": {
              "current-page": {
                "schema": {
                  "type": "integer"
                },
                "description": "Current page number"
              },
              "page-items": {
                "schema": {
                  "type": "integer"
                },
                "description": "Number of items per page"
              },
              "total-count": {
                "schema": {
                  "type": "integer"
                },
                "description": "Total number of products"
              },
              "total-pages": {
                "schema": {
                  "type": "integer"
                },
                "description": "Total number of pages"
              }
            },
            "content": {
              "application/json": {
                "example": [
                  {
                    "id": "dec89372-e495-466d-9a7b-8dcebcf1bdb5",
                    "reference": "1234567890",
                    "requested_brand": "adidas",
                    "requested_country": "US",
                    "face_value": 10,
                    "discount": 0,
                    "price": 10,
                    "currency": "USD",
                    "status": "pending",
                    "created_at": "2026-10-05T10:22:20.284Z"
                  }
                ],
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "reference": {
                        "type": "string"
                      },
                      "requested_brand": {
                        "type": "string"
                      },
                      "requested_country": {
                        "type": "string"
                      },
                      "face_value": {
                        "type": "number"
                      },
                      "price": {
                        "type": "number"
                      },
                      "currency": {
                        "type": "string"
                      },
                      "payment_currency": {
                        "type": "string",
                        "nullable": true,
                        "description": "Payment currency if different from order currency"
                      },
                      "fx_fee": {
                        "type": "number",
                        "nullable": true,
                        "description": "FX conversion fee applied (percentage)"
                      },
                      "discount": {
                        "type": "number",
                        "description": "Discount percentage. If negative, treated as a fee."
                      },
                      "status": {
                        "type": "string"
                      },
                      "created_at": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Unauthorized"
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Too many requests. Try again later."
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://{environment}.gifq.com",
      "variables": {
        "environment": {
          "default": "api-sandbox",
          "enum": [
            "api",
            "api-sandbox"
          ]
        }
      }
    }
  ]
}
```