Maginium
Admin Api
Admin Api
  • About
  • API reference
    • CustomerGroups
      • Permissions
      • Default
      • Search
    • Customers
      • Confirm
      • BillingAddress
      • ShippingAddress
      • Carts
      • Me
        • Activate
        • Password
        • BillingAddress
        • ShippingAddress
      • Search
      • Activate
      • Password
        • ResetLinkToken
      • ResetPassword
      • Validate
      • IsEmailAvailable
      • Addresses
      • Permissions
        • Readonly
    • CmsPage
      • Search
    • CmsBlock
      • Search
    • Products
      • Media
        • Types
      • Options
        • Types
      • Links
        • Types
        • Attributes
      • Websites
      • Downloadable links
        • Samples
      • Attributes
        • Options
        • Types
      • Attribute sets
        • Attributes
        • Groups
          • List
        • Sets
          • List
      • Tier prices
      • Types
      • Tier prices information
      • Tier prices delete
      • Base prices information
      • Base prices
      • Cost information
      • Cost
      • Cost delete
      • Special price information
      • Special price
      • Special price delete
      • StockItems
      • Group prices
        • Tiers
          • Price
    • Categories
      • Attributes
        • Options
      • Products
      • Move
      • List
    • StockItems
      • LowStock
        • /
    • Carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods by address id
      • Estimate shipping methods
      • Payment methods
      • Totals
      • Shipping information
      • Totals information
      • Mine
        • Items
        • Selected payment method
        • Billing address
        • Coupons
        • Payment information
        • Gift message
        • Order
        • Shipping methods
        • Estimate shipping methods by address id
        • Estimate shipping methods
        • Payment methods
        • Totals
        • Collect totals
        • Shipping information
        • Totals information
        • Set payment information
      • Licence
        • List
      • /
      • Search
    • Guest carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Payment information
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods
      • Payment methods
      • Collect totals
      • Totals
      • Shipping information
      • Totals information
      • Set payment information
    • Orders
      • Comments
      • Statuses
      • Cancel
      • Emails
      • Hold
      • Unhold
      • Items
      • Create
    • Invoices
      • Comments
      • Emails
      • Void
      • Capture
      • /
    • Creditmemo
      • Comments
      • Emails
      • Refund
    • Shipment
      • Comments
      • Emails
      • Label
      • Track
      • /
    • Transactions
    • TaxRates
      • Search
    • TaxRules
      • Search
    • TaxClasses
      • Search
    • SalesRules
      • Search
    • Coupons
      • Search
      • Generate
      • DeleteByIds
      • DeleteByCodes
    • Bulk
      • Detailed status
      • Status
      • Operation status
    • Modules
    • Search
    • Addresses
    • Products render info
    • StockStatuses
    • Creditmemos
    • Shipments
    • Amazon shipping address
    • Amazon billing address
    • Store
      • StoreViews
      • StoreGroups
      • Websites
      • StoreConfigs
    • Adobestock
      • Asset
        • Search
        • List
      • Search
    • Directory
      • Countries
      • Currency
    • Eav
      • Attribute sets
        • List
    • AttributeMetadata
      • Customer
        • Attribute
        • Form
        • Custom
      • CustomerAddress
        • Attribute
        • Form
        • Custom
    • Bundle products
      • Links
      • Options
        • Children
        • All
        • Types
        • Add
      • Children
    • Order
      • Refund
      • Ship
      • Invoice
      • Notify orders are ready for pickup
    • Configurable products
      • Children
      • Options
        • All
      • Child
      • Variation
    • Inventory
      • Sources
      • Stocks
      • Stock source links
      • Source items
      • Low quantity notification
      • Get sources assigned to stock ordered by priority
      • Stock source links delete
      • Source items delete
      • Bulk product source assign
      • Bulk product source unassign
      • Bulk product source transfer
      • Bulk partial source transfer
      • Get distance provider code
      • Get distance
      • Get latlng from address
      • Get latslngs from address
      • Export stock salable qty
      • Dump stock index data
      • Get product salable quantity
      • Is product salable
      • Are products salable
      • Is product salable for requested qty
      • Stock resolver
      • Source selection algorithm list
      • Source selection algorithm result
      • Low quantity notifications delete
      • Are product salable for requested qty
        • /
      • In store pickup
        • Pickup locations
          • /
    • Invoice
      • Refund
    • Analytics
      • Link
    • Amazon
      • Order ref
    • Applepay
      • Auth
    • Address
      • Cleanse
    • Guest address
      • Cleanse
    • Vertex address validation
      • Vertex address
    • Integration
      • Admin
        • Token
      • Customer
        • Token
Powered by GitBook
On this page
  1. API reference

Search

PreviousModulesNextAddresses

search V1Search Get

get

Make Full Text Search and return found Documents

Query parameters
searchCriteria[requestName]stringOptionalExample: <string>
searchCriteria[filterGroups][0][filters][0][field]stringOptional

Field

Example: <string>
searchCriteria[filterGroups][0][filters][0][value]stringOptional

Value

Example: <string>
searchCriteria[filterGroups][0][filters][0][conditionType]stringOptional

Condition type

Example: <string>
searchCriteria[sortOrders][0][field]stringOptional

Sorting field.

Example: <string>
searchCriteria[sortOrders][0][direction]stringOptional

Sorting direction.

Example: <string>
searchCriteria[pageSize]stringOptional

Page size.

Example: <integer>
searchCriteria[currentPage]stringOptional

Current page.

Example: <integer>
Responses
200
OK
application/json
Responseobject
500
Internal Server Error
application/json
get
GET /V1/search HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "items": [
    {
      "id": 49892386,
      "custom_attributes": [
        {
          "attribute_code": "nisi esse ex nostrud",
          "value": "sunt"
        },
        {
          "attribute_code": "anim tempor reprehenderit",
          "value": "consequat est ullamco"
        }
      ]
    },
    {
      "id": -51877456,
      "custom_attributes": [
        {
          "attribute_code": "non et",
          "value": "ex veniam"
        },
        {
          "attribute_code": "tempor laboris sunt pariatur",
          "value": "id esse"
        }
      ]
    }
  ],
  "aggregations": {
    "buckets": [
      {
        "name": "qui fugiat esse do",
        "values": [
          {
            "value": "proident dolor nisi eu",
            "metrics": [
              {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            ]
          },
          {
            "value": "amet velit cillum",
            "metrics": [
              {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            ]
          }
        ]
      },
      {
        "name": "velit ipsum laboris",
        "values": [
          {
            "value": "elit ut do",
            "metrics": [
              {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            ]
          },
          {
            "value": "ut ",
            "metrics": [
              {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              },
              {
                "value": "<Error: Too many levels of nesting to fake this schema>"
              }
            ]
          }
        ]
      }
    ],
    "bucket_names": [
      "non dolore",
      "in laborum adipisicing"
    ]
  },
  "search_criteria": {
    "request_name": "laborum tempor ess",
    "filter_groups": [
      {
        "filters": [
          {
            "field": "non dolore do",
            "value": "nisi qui",
            "condition_type": "exercitation reprehenderit si"
          },
          {
            "field": "",
            "value": "incididunt ut",
            "condition_type": "cupidatat tempor"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "Excepteur irure sed nostrud",
            "value": "eiusmod minim",
            "condition_type": ""
          },
          {
            "field": "labore magna sed enim ea",
            "value": "irure dolor ut eiusmod eu",
            "condition_type": "sit velit"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "qui ex reprehenderit",
        "direction": "proident aute occaecat aliquip"
      },
      {
        "field": "nostrud aliqua proident labore pariatur",
        "direction": "velit laboris"
      }
    ],
    "page_size": 28844979,
    "current_page": 77335562
  },
  "total_count": -35256403
}