shop.dev

{
  "properties": {
    "orders": {
      "properties": {
        "filters": {
          "description": "Narrow the search; fields AND.",
          "properties": {
            "date": {
              "description": "Order placement dates, YYYY-MM-DD.",
              "properties": {
                "from": {
                  "format": "date",
                  "type": "string"
                },
                "to": {
                  "format": "date",
                  "type": "string"
                }
              },
              "title": "Date Range",
              "type": "object"
            },
            "status": {
              "default": "in_progress",
              "description": "in_progress: orders still in progress. all: the full order history.",
              "enum": [
                "in_progress",
                "all"
              ],
              "type": "string"
            }
          },
          "title": "Search Filters",
          "type": "object"
        },
        "pagination": {
          "description": "Page orders and standalone shipments together.",
          "properties": {
            "cursor": {
              "description": "Pass unchanged with the same query and filters.",
              "minLength": 1,
              "type": "string"
            },
            "limit": {
              "default": 5,
              "description": "Page size. Defaults to 5; maximum 10.",
              "maximum": 10,
              "minimum": 1,
              "type": "integer"
            }
          },
          "title": "Pagination Request",
          "type": "object"
        },
        "query": {
          "description": "Merchant, item, or order number; omit to list.",
          "maxLength": 200,
          "type": "string"
        }
      },
      "title": "Search Request",
      "type": "object"
    }
  },
  "required": [
    "orders"
  ],
  "type": "object"
}