---
updatedAt: 2026-04-20T23:02:19.000Z
agentTools:
  projectIndex: https://developer.vinoshipper.com/llms.txt
---

# Search Order Options


            Returns available options for order search UI including all possible order statuses and sort fields.
            This endpoint provides metadata to populate dropdown menus and filter options in the UI.
        

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Vinoshipper API Docs",
    "version": "3.0",
    "x-logo": {
      "url": "/static/img/brand/vinoshipper-logo.svg"
    }
  },
  "servers": [
    {
      "url": "https://vinoshipper.com"
    }
  ],
  "tags": [
    {
      "name": "Order",
      "description": "Post-purchase order operations"
    },
    {
      "name": "Order",
      "description": "Pre-purchase order operations"
    }
  ],
  "paths": {
    "/api/v3/p/orders/search/ui-options": {
      "get": {
        "tags": [
          "Order"
        ],
        "summary": "Search Order Options",
        "description": "\n            Returns available options for order search UI including all possible order statuses and sort fields.\n            This endpoint provides metadata to populate dropdown menus and filter options in the UI.\n        ",
        "operationId": "uiOptions",
        "responses": {
          "200": {
            "description": "Operation successful",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderSearchOptions"
                }
              }
            }
          },
          "400": {
            "description": "Request has failed validation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed"
          },
          "403": {
            "description": "Insufficient permission",
            "content": {}
          },
          "404": {
            "description": "Not Found"
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "BasicAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "required": [
          "code",
          "description"
        ],
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "field": {
            "type": "string"
          },
          "shortDescription": {
            "type": "string"
          }
        }
      },
      "ErrorDetails": {
        "required": [
          "status",
          "type"
        ],
        "type": "object",
        "properties": {
          "status": {
            "type": "integer",
            "format": "int32"
          },
          "type": {
            "type": "string",
            "enum": [
              "VALIDATION",
              "COMPLIANCE",
              "PAYMENT_FAILURE",
              "SERVER_ERROR",
              "ACCESS_DENIED",
              "CONFLICT"
            ]
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "ErrorResponse": {
        "required": [
          "error"
        ],
        "type": "object",
        "properties": {
          "error": {
            "$ref": "#/components/schemas/ErrorDetails"
          }
        }
      },
      "OrderSearchOptions": {
        "type": "object",
        "properties": {
          "status": {
            "type": "array",
            "description": "Order status valid values",
            "items": {
              "type": "string",
              "description": "Queryable order statuses",
              "enum": [
                "OPEN",
                "LABELS_GENERATED",
                "SENT_TO_FULFILLMENT",
                "SHIPPED",
                "RETURNED",
                "DELIVERED",
                "CANCELLED"
              ]
            }
          },
          "shippingClass": {
            "type": "array",
            "description": "Available shipping class codes",
            "items": {
              "$ref": "#/components/schemas/ShippingClassCode"
            }
          },
          "sortBy": {
            "type": "array",
            "description": "Result sorting options",
            "items": {
              "type": "string",
              "description": "Available fields for sorting orders",
              "enum": [
                "DESTINATION_STATE",
                "DESTINATION_CITY",
                "SHIPPING_CLASS",
                "SHIPMENT_STATUS",
                "ORDER_DATE",
                "SHIP_DATE",
                "REQUESTED_SHIP_DATE",
                "BUYER_NAME",
                "MEMBER_NAME"
              ]
            }
          },
          "deliveryType": {
            "type": "array",
            "description": "Delivery type filter options",
            "items": {
              "type": "string",
              "description": "Delivery type filter options for orders",
              "enum": [
                "PICKUP",
                "SHIPMENT",
                "LOCAL_DELIVERY",
                "DIGITAL_DELIVERY"
              ]
            }
          },
          "cartType": {
            "type": "array",
            "description": "Cart type filter options. Empty where the search cannot filter on cart type.",
            "items": {
              "$ref": "#/components/schemas/ValueAndNameForEnumCartType"
            }
          }
        },
        "description": "Valid options for search query"
      },
      "ShippingClassCode": {
        "required": [
          "code",
          "description"
        ],
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Shipping class code identifier"
          },
          "description": {
            "type": "string",
            "description": "Human readable shipping class description"
          }
        },
        "description": "Shipping class option with code and description"
      },
      "ValueAndNameForEnumCartType": {
        "required": [
          "value"
        ],
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "enum": [
              "CONSUMER",
              "API",
              "IMPORT",
              "AMAZON",
              "POINT_OF_SALE",
              "WHOLESALE",
              "MOBILE_APP",
              "WINE_CLUB",
              "PROGRAM",
              "MULTIPLE",
              "DAMAGE_CLAIM",
              "COMBINED"
            ]
          },
          "name": {
            "type": "string"
          }
        },
        "description": "Cart type filter options. Empty where the search cannot filter on cart type."
      }
    },
    "securitySchemes": {
      "BasicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  }
}
```