GET
/
crm
/
v3
/
objects
/
commerce_payments
/
{commercePaymentId}
Leer
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/commerce_payments/{commercePaymentId} \
  --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"
}
Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubGratuito
Sales HubSales HubGratuito
Service HubService HubGratuito
Content HubContent HubGratuito

​
Ámbitos Requeridos

Esta API requiere uno de los siguientes ámbitos:
  • crm.objects.commercepayments.read

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
commercePaymentId
string
required

Query Parameters

​
properties
string[]

Una lista separada por comas de las propiedades que se devolverán en la respuesta. Si alguna de las propiedades especificadas no está presente en los objetos solicitados, se ignorará.

​
propertiesWithHistory
string[]

Una lista separada por comas de las propiedades que se devolverán junto con su historial de valores anteriores. Si alguna de las propiedades especificadas no está presente en los objetos solicitados, se ignorará.

​
associations
string[]

Una lista separada por comas de los tipos de objetos para los que se desea recuperar los ID asociados. Si alguna de las asociaciones especificadas no existe, se ignorará.

​
archived
boolean
default:false

Si se quieren devolver solo los resultados que se han archivado.

​
idProperty
string

El nombre de una propiedad cuyos valores son únicos 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