GET
/
crm
/
v3
/
objects
/
orders
/
{orderId}
Ler
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/orders/{orderId} \
  --header 'Authorization: Bearer <token>'
{
  "associations": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "archived": true,
  "archivedAt": "2023-11-07T05:31:56Z",
  "propertiesWithHistory": {},
  "id": "<string>",
  "objectWriteTraceId": "<string>",
  "properties": {},
  "updatedAt": "2023-11-07T05:31:56Z"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • 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

​
orderId
string
required

Query Parameters

​
properties
string[]

Uma lista separada por vírgulas das propriedades a serem retornadas na resposta. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada.

​
propertiesWithHistory
string[]

Uma lista separada por vírgulas das propriedades a serem retornadas junto com seu histórico de valores anteriores. Se alguma das propriedades especificadas não estiver presente nos objetos solicitados, ela será ignorada.

​
associations
string[]

Uma lista separada por vírgulas de tipos de objeto para recuperar IDs associados. Se alguma das associações especificadas não existir, elas serão ignoradas.

​
archived
boolean
default:false

Se apenas os resultados que foram arquivados devem ser retornados.

​
idProperty
string

O nome de uma propriedade cujos valores são exclusivos para este objeto

Response

successful operation

Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.

​
createdAt
string<date-time>
required

The timestamp when the object was created, in ISO 8601 format.

​
id
string
required

The unique ID of the object.

​
properties
object
required

Key value pairs representing the properties of the object.

​
updatedAt
string<date-time>
required

The timestamp when the object was last updated, in ISO 8601 format.

​
associations
object

A list defining relationships with other objects.

​
archived
boolean

Whether the object is archived.

​
archivedAt
string<date-time>

The timestamp when the object was archived, in ISO 8601 format.

​
propertiesWithHistory
object

Key-value pairs representing the properties of the object along with their history.

​
objectWriteTraceId
string