HUhubspot
Batch

Retrieve a batch of carts

Changed on

Retrieve carts by ID, or include the idProperty parameter to retrieve carts by a custom unique value property.

post/crm/objects/2026-03/carts/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/objects/2026-03/carts/batch/read
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Query parameters

archivedboolean

Whether to return only results that have been archived.

Request body

idPropertystring

When using a custom unique value property to retrieve records, the name of the property. Do not include this parameter if retrieving by record ID.

propertiesstring[] required

Key-value pairs for setting properties for the new object.

propertiesWithHistorystring[] required

Key-value pairs for setting properties for the new object and their histories.

Example request

{
  "inputs": [
    {
      "id": "430001"
    }
  ]
}

Response

successful operation

completedAtstring date-time required

The timestamp when the batch processing was completed, in ISO 8601 format.

linksobject

An object containing relevant links related to the batch request.

requestedAtstring date-time

The timestamp when the batch request was initially made, in ISO 8601 format.

startedAtstring date-time required

The timestamp when the batch processing began, in ISO 8601 format.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE"

Changes

  • e0403341222cRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the media type application/json for the response with the status

  • dc2fdad57f7fRevision changes
    • info

      api operation id post-/crm/objects/2026-03/carts/batch/read_/crm/objects/2026-03/carts/batch/read removed and replaced with post-/crm/objects/2026-03/carts/batch/read

    • info

      added the success response with the status

Some revisions have not been checked yet.