Zum Hauptinhalt springen
POST
/
crm
/
v3
/
objects
/
orders
/
search
Suchen Sie im CRM-System mit verschiedenen Filtern und Sortierungen nach Bestellungen, um spezifische Ihre Bestellungsdaten abzurufen.
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/orders/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "after": "<string>",
  "filterGroups": [
    {
      "filters": [
        {
          "highValue": "<string>",
          "operator": "BETWEEN",
          "propertyName": "<string>",
          "value": "<string>",
          "values": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "limit": 123,
  "properties": [
    "<string>"
  ],
  "query": "<string>",
  "sorts": [
    "<string>"
  ]
}'
{
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  },
  "results": [
    {
      "archived": false,
      "createdAt": "2019-10-30T03:30:17.883Z",
      "id": "512",
      "properties": {
        "property_checkbox": "false",
        "property_date": "1572480000000",
        "property_dropdown": "choice_b",
        "property_multiple_checkboxes": "chocolate;strawberry",
        "property_number": "17",
        "property_radio": "option_1",
        "property_string": "value"
      },
      "updatedAt": "2019-12-07T16:50:06.678Z"
    }
  ],
  "total": 123
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos
Diese API erfordert einen der folgenden Bereiche:
crm.objects.orders.read

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

objectType
string
required

Gibt den Typ des Objekts an, nach dem gesucht werden soll. Es handelt sich in diesem Kontext um „Bestellungen“.

Body

application/json

Describes a search request

after
string
required

A paging cursor token for retrieving subsequent pages.

filterGroups
object[]
required

Up to 6 groups of filters defining additional query criteria.

limit
integer
required

The maximum results to return, up to 200 objects.

properties
string[]
required

A list of property names to include in the response.

sorts
string[]
required

Specifies sorting order based on object properties.

query
string

The search query string, up to 3000 characters.

Response

successful operation

results
object[]
required
total
integer
required

The number of available results

paging
object