HubSpot: Carts schemas

← Carts operations · All schemas

Batch archive objects — carts batch Delete Carts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input payload containing a list of simple public object IDs. This component is used when performing batch operations on multiple objects within HubSpot.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing the ID of a CRM object to be processed in the batch operation.
inputs[]	Model	Each item	Expand Read batch objects — carts batch Get Carts — request body — body inputs item

Referenced models: Read batch objects — carts batch Get Carts — request body — body inputs item

Batch create objects — carts batch Create Carts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once.
inputs	array	Required within parent	An array of objects to be created, each represented by a SimplePublicObjectBatchInputForCreate. Each object includes properties and optional associations.
inputs[]	Model	Each item	Expand Batch create objects — carts batch Create Carts — request body — body inputs item

Referenced models: Batch create objects — carts batch Create Carts — request body — body inputs item

Batch create objects — carts batch Create Carts — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	An input object that contains a collection of objects to be created together in a batch.
associations	array	Required within parent	An array of associations that define the relationships between the CRM objects being created and other objects. Each association is represented by a 'PublicAssociationsForObject' object.
associations[]	Model	Each item	Expand Create — carts create Cart — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operations for the objects being created. This can be used for debugging and tracking purposes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are the corresponding property values for the CRM objects being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — carts create Cart — request body — body associations item

Create — carts create Cart — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Is the input object used to create a new CRM object, containing the properties to be set and optional associations to link the new record with other CRM objects.
associations	array	Required within parent	An array of associations that link the new CRM object to other objects. Each association specifies the target object and the type of association.
associations[]	Model	Each item	Expand Create — carts create Cart — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and the value is the property's value. These properties define the attributes of the CRM object being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — carts create Cart — request body — body associations item

Create — carts create Cart — request body — body associations item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the associations for a specific object in HubSpot, detailing the types of associations and the related objects involved.
to	Model	Required within parent	Expand Create — carts create Cart — request body — body associations item to
types	array	Required within parent	An array of association specifications that define the types of associations between the objects. Each item in the array follows the AssociationSpec schema.
types[]	Model	Each item	Expand Create — carts create Cart — request body — body associations item types item

Referenced models: Create — carts create Cart — request body — body associations item types item, Create — carts create Cart — request body — body associations item to

Create — carts create Cart — request body — body associations item to

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	The unique identifier for the public object. It is a string data type.

Create — carts create Cart — request body — body associations item types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
associationCategory	string	Required within parent	The category of the association, which can be one of 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', or 'WORK'. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeId	integer	Required within parent	An integer representing the unique identifier for the type of association. Format: int32

Create — carts create Cart — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
archived	boolean	Required within parent	A boolean indicating whether this object has been archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
objectWriteTraceId	string	Optional	A string identifier used for tracing the write operations on this object.
properties	object	Required within parent	A map of property names to their current values, represented as strings. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their historical values, each represented as an array of values with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — carts get Cart — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL associated with this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — carts get Cart — response body — warnings item

Referenced models: Read — carts get Cart — response body — warnings item, Read — carts get Cart — response body — properties With History value item

GDPR Delete — carts gdpr Delete — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	An input that contains the information required to process a public GDPR data deletion request.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectId	string	Required within parent	The unique identifier of the object to be deleted. This is a required property and must be provided as a string.

List Associations — carts get Associations By To Object Type — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection of objects that are associated with multiple labels, including the results and pagination details. This component is used when retrieving associated objects with specific labels in a forward-paging manner.
paging	Model	Optional	Expand Retrieve companies — response body — paging
results	array	Required within parent	An array of objects, each representing an associated object with its labels. Each item in the array is a 'MultiAssociatedObjectWithLabel'.
results[]	Model	Each item	Expand List Associations — carts get Associations By To Object Type — response body — results item

Referenced models: Retrieve companies — response body — paging, List Associations — carts get Associations By To Object Type — response body — results item

List Associations — carts get Associations By To Object Type — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object that is associated with multiple other objects, with optional context.
associationTypes	array	Required within parent	An array of association types with labels that define the nature of the association between objects. Each item in the array is an AssociationSpecWithLabel object.
associationTypes[]	Model	Each item	Expand List Associations — carts get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the target object to which the association is made. It is a string.

Referenced models: List Associations — carts get Associations By To Object Type — response body — results item association Types item

List Associations — carts get Associations By To Object Type — response body — results item association Types item

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
category	string	Required within parent	A string indicating the category of the association. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	A string representing the object type ID from which the association originates.
label	string	Optional	A string that provides an optional label for the association.
toObjectTypeId	string	Optional	A string representing the object type ID to which the association points.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	An integer representing the unique identifier for the association type. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — carts get Carts — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a paginated collection response that includes simple public objects with their associations. This component is used to handle the results and pagination details when retrieving a list of objects from the API.
paging	Model	Optional	Expand Retrieve companies — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing a CRM object with its associated data.
results[]	Model	Each item	Expand Read — carts get Cart — response body

Referenced models: Retrieve companies — response body — paging, Read — carts get Cart — response body

Read batch objects — carts batch Get Carts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the input for reading a batch of CRM objects, including arrays of object IDs, requested property names (with optional history), and an optional unique identifying property.
idProperty	string	Optional	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.
inputs	array	Required within parent	An array of SimplePublicObjectId objects, each containing an ID of an object to be read.
inputs[]	Model	Each item	Expand Read batch objects — carts batch Get Carts — request body — body inputs item
properties	array	Required within parent	An array of strings representing the properties to be returned in the response. Each string specifies a property name.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings representing the properties to be returned along with their history of previous values. Each string specifies a property name.
propertiesWithHistory[]	string	Each item

Referenced models: Read batch objects — carts batch Get Carts — request body — body inputs item

Read batch objects — carts batch Get Carts — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	A string representing the unique identifier for the object.

Read batch objects — carts.batchGetCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
category	string	Required within parent	A string that categorizes the error.
context	object	Required within parent	An object containing additional context about the error, with each property being an array of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about individual errors.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string representing a unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation or recommended remediation steps for the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

Referenced models: Batch insert events — response body — errors item errors item

Read batch objects — carts.batchGetCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Carts Batch Response Simple Public Object

Field	Type	Presence	Description and constraints
$	object	Root	A public object batch response object
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional context or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Create — carts create Cart — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create — carts create Cart — response body

Read batch objects — carts.batchGetCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Carts Batch Response Simple Public Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — carts.batchGetCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs providing additional information about the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicObject items representing the successful results of the batch operation.
results[]	Model	Each item	Expand Create — carts create Cart — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read batch objects — carts.batchGetCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create — carts create Cart — response body

Read — carts get Cart — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
associations	object	Optional	A map of associated object types to collections of associated IDs, representing the associations of this object with other objects. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — carts get Cart — response body — associations value
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
objectWriteTraceId	string	Optional	An identifier used to trace the write operations for this object.
properties	object	Required within parent	A map of property names to their values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values, including a history of previous values, represented as arrays of values with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — carts get Cart — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL associated with this object.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — carts get Cart — response body — warnings item

Referenced models: Read — carts get Cart — response body — associations value, Read — carts get Cart — response body — warnings item, Read — carts get Cart — response body — properties With History value item

Read — carts get Cart — response body — associations value

Field	Type	Presence	Description and constraints
$	object	Root	Represents a collection of associated IDs returned by an API request, including pagination details for navigating through the results.
paging	Model	Optional	Expand Search objects — carts search Carts — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an 'AssociatedId' object. This property is required.
results[]	Model	Each item	Expand Read — taxes get Tax — response body — associations value results item

Referenced models: Read — taxes get Tax — response body — associations value results item, Search objects — carts search Carts — response body — paging

Read — carts get Cart — response body — properties With History value item

Field	Type	Presence	Description and constraints
$	object	Root	Property model that includes timestamp.
sourceId	string	Optional	A string identifier for the specific source of the value.
sourceLabel	string	Optional	A string label providing additional context or description for the source.
sourceType	string	Required within parent	A string indicating the type of source from which the value was obtained. This field is required.
timestamp	string	Required within parent	The date and time when the value was recorded, in ISO 8601 format. Format: date-time
updatedByUserId	JSON	Optional
updatedByUserId (anyOf 1)	integer	Alternative	An integer representing the ID of the user who last updated the value. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
value	string	Required within parent	The actual value of the property at the given timestamp. It is a string.

Read — carts get Cart — response body — warnings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
category	string	Required within parent	A string representing the category of the warning.
context	object	Required within parent	An object providing additional context for the warning, with string properties. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Search objects — carts search Carts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Describes a search request
after	string	Required within parent	A string representing the paging cursor token. This is used to retrieve the next set of results in a paginated response.
filterGroups	array	Required within parent	An array of filter groups to apply to the search. Each filter group contains filters that define specific conditions for the search.
filterGroups[]	Model	Each item	Expand Search objects — carts search Carts — request body — body filter Groups item
limit	integer	Required within parent	An integer indicating the maximum number of results to return. This property helps control the page size of the search results. Format: int32
properties	array	Required within parent	An array of strings specifying which properties of the CRM objects should be included in the search results.
properties[]	string	Each item
query	string	Optional	A string representing a search query to match against the CRM objects.
sorts	array	Required within parent	An array of strings specifying the sort order of the search results. Each string represents a property to sort by, optionally followed by a direction (e.g., 'propertyName ASC').
sorts[]	string	Each item

Referenced models: Search objects — carts search Carts — request body — body filter Groups item

Search objects — carts search Carts — request body — body filter Groups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a group of filters used to query data within HubSpot. This component is used to define criteria for filtering records in various API endpoints.
filters	array	Required within parent	An array of filter objects that define the criteria for the search. Each filter specifies a property, an operator, and a value to match against.
filters[]	Model	Each item	Expand Search objects — carts search Carts — request body — body filter Groups item filters item

Referenced models: Search objects — carts search Carts — request body — body filter Groups item filters item

Search objects — carts search Carts — request body — body filter Groups item filters item

Field	Type	Presence	Description and constraints
$	object	Root	Defines a single condition for searching CRM objects, specifying the property to filter on, the operator to use (such as equals, greater than, or contains), and the value(s) to compare against.
highValue	string	Optional	An optional string value used for range-based filters to specify the upper limit.
operator	string	Required within parent	The operator that defines the type of comparison to be made. Valid values include 'EQ', 'NEQ', 'LT', 'LTE', 'GT', 'GTE', 'BETWEEN', 'IN', 'NOT_IN', 'HAS_PROPERTY', 'NOT_HAS_PROPERTY', 'CONTAINS_TOKEN', and 'NOT_CONTAINS_TOKEN'. One of: BETWEEN, CONTAINS_TOKEN, EQ, GT, GTE, HAS_PROPERTY, IN, LT, LTE, NEQ, NOT_CONTAINS_TOKEN, NOT_HAS_PROPERTY, NOT_IN
propertyName	string	Required within parent	The name of the property to filter by. This is a string value.
value	string	Optional	The specific value to filter for the given property. This is a string value.
values	array	Optional	An array of string values used for filters that involve multiple possible matches, such as 'IN' or 'NOT_IN' operators.
values[]	string	Each item

Search objects — carts search Carts — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a list of simple objects returned from an API request, along with the total count of objects available.
paging	Model	Optional	Expand Search objects — carts search Carts — response body — paging
results	array	Required within parent	An array of simple public objects included in the current page of the collection.
results[]	Model	Each item	Expand Create — carts create Cart — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	The number of available results Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Search objects — carts search Carts — response body — paging, Create — carts create Cart — response body

Search objects — carts search Carts — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand Retrieve companies — response body — paging next
prev	Model	Optional	Expand Search objects — carts search Carts — response body — paging prev

Referenced models: Retrieve companies — response body — paging next, Search objects — carts search Carts — response body — paging prev

Search objects — carts search Carts — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token that indicates the position of the last item on the previous page. It is used to retrieve the preceding set of results.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Update batch objects — carts batch Update Carts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInput objects, each representing a CRM object to be updated. Each object includes its properties and identifiers.
inputs[]	Model	Each item	Expand Update batch objects — carts batch Update Carts — request body — body inputs item

Referenced models: Update batch objects — carts batch Update Carts — request body — body inputs item

Update batch objects — carts batch Update Carts — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.
id	string	Required within parent	The id to be updated. This can be the object id, or the unique property value of the idProperty property
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string used to trace the write operation for the object.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are property values for the object. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — carts update Cart — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the input required to update a CRM object, containing an object with property names and their corresponding values.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object to be updated. Each key is a property name, and each value is the new value for that property. All properties are strings. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — carts batch Upsert Carts — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.
inputs	array	Required within parent	An array of objects to be upserted, each represented by a SimplePublicObjectBatchInputUpsert schema.
inputs[]	Model	Each item	Expand Upsert batch objects — carts batch Upsert Carts — request body — body inputs item

Referenced models: Upsert batch objects — carts batch Upsert Carts — request body — body inputs item

Upsert batch objects — carts batch Upsert Carts — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
id	string	Required within parent	A string representing the unique identifier of the object. This is used to identify the object in the batch operation.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string used to trace the write operation for the object, useful for debugging and tracking changes.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the object to be upserted. Each key is a property name, and the value is the property value. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — carts.batchUpsertCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object that has either been created or updated (upserted)
archived	boolean	Required within parent	A boolean indicating whether the object is archived.
archivedAt	string	Optional	The date and time when the object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the object, represented as a string.
new	boolean	Required within parent	A boolean indicating whether the object is newly created.
objectWriteTraceId	string	Optional	A string identifier used for tracing the write operation of the object.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of their historical values, each entry containing a value and its timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — carts get Cart — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when the object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL of the object.
warnings	array	Optional	An array of warnings related to the object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Read — carts get Cart — response body — warnings item

Referenced models: Read — carts get Cart — response body — warnings item, Read — carts get Cart — response body — properties With History value item

Upsert batch objects — carts.batchUpsertCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Carts Batch Response Simple Public Upsert Object

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional resources or documentation related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of SimplePublicUpsertObject items representing the individual results of the upsert operation for each object in the batch.
results[]	Model	Each item	Expand Upsert batch objects — carts.batchUpsertCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Upsert batch objects — carts.batchUpsertCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — carts.batchUpsertCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Carts Batch Response Simple Public Upsert Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each represented as a StandardError.
errors[]	Model	Each item	Expand Read batch objects — carts.batchGetCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional context or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch upsert operation, each represented as a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Upsert batch objects — carts.batchUpsertCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read batch objects — carts.batchGetCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Upsert batch objects — carts.batchUpsertCarts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item