HubSpot: Products schemas

← Products operations · All schemas

Batch archive objects — products batch Delete Products — 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 representing the ID of a public object to be processed in the batch operation.
inputs[]	Model	Each item	Expand Read batch objects — tickets batch Get Tickets — request body — body inputs item

Referenced models: Read batch objects — tickets batch Get Tickets — request body — body inputs item

Batch create objects — products batch Create Products — 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 SimplePublicObjectBatchInputForCreate objects, each containing the properties and associations needed to create a single CRM object.
inputs[]	Model	Each item	Expand Batch create objects — products batch Create Products — request body — body inputs item

Referenced models: Batch create objects — products batch Create Products — request body — body inputs item

Batch create objects — products batch Create Products — 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 relationships between the CRM objects being created and other objects. Each association is specified using the PublicAssociationsForObject schema.
associations[]	Model	Each item	Expand Create — products create Product — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging 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 — products create Product — request body — body associations item

Batch read objects — products batch Get Products — 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 representing the IDs of the objects to be read.
inputs[]	Model	Each item	Expand Read batch objects — tickets batch Get Tickets — request body — body inputs item
properties	array	Required within parent	An array of strings representing the properties to be returned in the response. If a specified property is not present on the requested objects, it will be ignored.
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. If a specified property is not present on the requested objects, it will be ignored.
propertiesWithHistory[]	string	Each item

Referenced models: Read batch objects — tickets batch Get Tickets — request body — body inputs item

Batch read objects — products.batchGetProducts — 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 keys as context names and values as arrays 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 that provide further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string representing the unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs containing documentation about the error or recommended remediation steps. 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 that provides more specific categorization of the error.

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

Batch read objects — products.batchGetProducts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Products 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 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 SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Merge objects — products merge — 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: Merge objects — products merge — response body

Batch read objects — products.batchGetProducts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Products 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 errors that occurred during the batch operation, each represented by a StandardError object.
errors[]	Model	Each item	Expand Batch read objects — products.batchGetProducts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional information 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 number of errors that occurred 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 simple public objects that were processed in the batch operation.
results[]	Model	Each item	Expand Merge objects — products merge — response body
startedAt	string	Required within parent	The date and time when the batch operation was 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: Merge objects — products merge — response body, Batch read objects — products.batchGetProducts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Create — products create Product — 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 this object to other objects. Each association specifies the target object and the types of associations to be created.
associations[]	Model	Each item	Expand Create — products create Product — request body — body associations item
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each 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 — products create Product — request body — body associations item

Create — products create Product — 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 — products create Product — request body — body associations item to
types	array	Required within parent	An array of association specifications, each defining the type of relationship between the objects.
types[]	Model	Each item	Expand Create — products create Product — request body — body associations item types item

Referenced models: Create — products create Product — request body — body associations item types item, Create — products create Product — request body — body associations item to

Create — products create Product — 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 CRM object. It is a string value that serves as a reference to the specific object within the system.

Create — products create Product — 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, indicating its origin or purpose. Valid values include 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', and 'WORK'. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeId	integer	Required within parent	An integer representing the specific type of association between objects. Format: int32

List associations — products 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 List — products get Products — response body — paging
results	array	Required within parent	An array of objects, each representing a CRM object with multiple associations and their corresponding labels.
results[]	Model	Each item	Expand List associations — products get Associations By To Object Type — response body — results item

Referenced models: List — products get Products — response body — paging, List associations — products get Associations By To Object Type — response body — results item

List associations — products 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 specifications, each with a label, defining the types of associations with the target object.
associationTypes[]	Model	Each item	Expand List associations — products 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 associations are made. It is a string.

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

List associations — products 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	The category of the association, which can be one of 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', or 'WORK'. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
fromObjectTypeId	string	Optional	The object type ID of the source object in the association.
label	string	Optional	A string label that can be used to describe the association.
toObjectTypeId	string	Optional	The object type ID of the target object in the association.
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 — products get Products — 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 List — products get Products — response body — paging
results	array	Required within parent	An array of simple public objects with associations. Each object includes its properties, associations, and metadata.
results[]	Model	Each item	Expand Read — products get Product — response body

Referenced models: List — products get Products — response body — paging, Read — products get Product — response body

List — products get Products — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand List — products get Products — response body — paging next

Referenced models: List — products get Products — response body — paging next

List — products get Products — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token used as a cursor to fetch the next page of results in a paginated response.
link	string	Optional	A string representing the URL link to the next page of results.

Merge objects — products merge — 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 is 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, represented as a string.
objectWriteTraceId	string	Optional	A string used to trace the write operations for this 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 an array of historical values, each with a timestamp and source information. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — products get Product — 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 of 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 Merge goal targets — response body — warnings item

Referenced models: Merge goal targets — response body — warnings item, Read — products get Product — response body — properties With History value item

Read — products get Product — 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 their associated IDs. Additional keys: see wildcard field
associations.*	Model	Additional keys	Expand Read — products get Product — 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 for tracing the write operations on this object.
properties	object	Required within parent	A map of property names to their current values for the 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 with timestamps. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — products get Product — 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 link to access this object.
warnings	array	Optional	A list of warnings associated with this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Merge goal targets — response body — warnings item

Referenced models: Merge goal targets — response body — warnings item, Read — products get Product — response body — associations value, Read — products get Product — response body — properties With History value item

Read — products get Product — 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 — products search Products — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an object that includes details about the association. This property is required.
results[]	Model	Each item	Expand Read — products get Product — response body — associations value results item

Referenced models: Read — products get Product — response body — associations value results item, Search — products search Products — response body — paging

Read — products get Product — response body — associations value results item

Field	Type	Presence	Description and constraints
$	object	Root	Contains the id and type of an association
id	string	Required within parent	The unique identifier for the associated object. It is a string.
type	string	Required within parent	The type of the associated object. It is a string.

Read — products get Product — 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 that provided the value.
sourceLabel	string	Optional	A string label describing the source of the value.
sourceType	string	Required within parent	A string indicating the type of source that provided the value.
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 current value of the property, represented as a string.

Search — products search Products — 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 to retrieve results after a specific point.
filterGroups	array	Required within parent	An array of filter groups used to refine the search results. Each filter group contains a set of filters that are applied together.
filterGroups[]	Model	Each item	Expand Search — products search Products — request body — body filter Groups item
limit	integer	Required within parent	An integer indicating the maximum number of results to return. Format: int32
properties	array	Required within parent	An array of strings specifying which properties of the objects should be returned in the search results.
properties[]	string	Each item
query	string	Optional	A string representing the search query to be applied.
sorts	array	Required within parent	An array of strings specifying the sorting order of the search results.
sorts[]	string	Each item

Referenced models: Search — products search Products — request body — body filter Groups item

Search — products search Products — 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 filter by.
filters[]	Model	Each item	Expand Search — products search Products — request body — body filter Groups item filters item

Referenced models: Search — products search Products — request body — body filter Groups item filters item

Search — products search Products — 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 representing the upper bound value for range-based filters.
operator	string	Required within parent	The operator used for the filter condition. It is a string and 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. It is a string that identifies which property of the object the filter applies to.
value	string	Optional	The specific value to filter for. This is a string that represents the target value for the specified property.
values	array	Optional	An array of strings representing multiple values for the filter. This is used when the filter operator supports multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search — products search Products — 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 — products search Products — response body — paging
results	array	Required within parent	An array of simple public objects contained in the current page of the collection.
results[]	Model	Each item	Expand Merge objects — products merge — 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 — products search Products — response body — paging, Merge objects — products merge — response body

Search — products search Products — 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 List — products get Products — response body — paging next
prev	Model	Optional	Expand Search for goal targets — response body — paging prev

Referenced models: Search for goal targets — response body — paging prev, List — products get Products — response body — paging next

Update batch objects — products batch Update Products — 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 items, each containing the properties and identifiers necessary for updating a specific CRM object.
inputs[]	Model	Each item	Expand Update batch objects — products batch Update Products — request body — body inputs item

Referenced models: Update batch objects — products batch Update Products — request body — body inputs item

Update batch objects — products batch Update Products — 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 operations for the objects in the batch, useful for debugging and tracking changes.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property's value. This is used to define the attributes of the CRM objects in the batch. Additional keys: see wildcard field
properties.*	string	Additional keys

Update — products update Product — 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 where keys are property names and values are the corresponding property values. Each property value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — products batch Upsert Products — 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 SimplePublicObjectBatchInputUpsert objects. Each object in the array contains the properties and identifiers needed for the upsert operation.
inputs[]	Model	Each item	Expand Upsert batch objects — products batch Upsert Products — request body — body inputs item

Referenced models: Upsert batch objects — products batch Upsert Products — request body — body inputs item

Upsert batch objects — products batch Upsert Products — 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 CRM object.
idProperty	string	Optional	The name of a property whose values are unique for this object
objectWriteTraceId	string	Optional	A string identifier used for tracing the write operation of the object.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object. Each key is a property name, and the value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — products.batchUpsertProducts — 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 this object is 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.
new	boolean	Required within parent	A boolean indicating whether this object is newly created.
objectWriteTraceId	string	Optional	A trace ID for tracking the write operation that created or updated this object.
properties	object	Required within parent	A map of property names to their current values for this object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to arrays of historical values, each with a timestamp and source information. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — products get Product — 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 to access this object in the HubSpot CRM.
warnings	array	Optional	An array of warnings related to this object, each containing a category, message, and context.
warnings[]	Model	Each item	Expand Merge goal targets — response body — warnings item

Referenced models: Merge goal targets — response body — warnings item, Read — products get Product — response body — properties With History value item

Upsert batch objects — products.batchUpsertProducts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Products 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 related links associated with the batch operation, where each key is a link name and each value is a URL. 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 objects that were upserted in the batch operation.
results[]	Model	Each item	Expand Upsert batch objects — products.batchUpsertProducts — 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 — products.batchUpsertProducts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — products.batchUpsertProducts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Products 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 StandardError objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Batch read objects — products.batchGetProducts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to their associated URIs, providing additional information 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 SimplePublicUpsertObject items representing the results of the batch upsert operation.
results[]	Model	Each item	Expand Upsert batch objects — products.batchUpsertProducts — 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 — products.batchUpsertProducts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Batch read objects — products.batchGetProducts — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item