HubSpot: Orders schemas

← Orders operations · All schemas

Batch archive objects — orders batch Delete Orders — 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 public object to be processed in the batch operation.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item

Referenced models: Archive a batch of contacts — request body — body inputs item

Batch create objects — orders batch Create Orders — 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. This array allows for the specification of multiple objects in a batch creation request.
inputs[]	Model	Each item	Expand Batch create objects — orders batch Create Orders — request body — body inputs item

Referenced models: Batch create objects — orders batch Create Orders — request body — body inputs item

Batch create objects — orders batch Create Orders — 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 objects defining the associations for the CRM object. Each association specifies the related object and the type of association.
associations[]	Model	Each item	Expand Create — orders create Order — request body — body associations item
objectWriteTraceId	string	Optional	A string used to trace the write operation for the object. This is useful 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 object. Each property is represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — orders create Order — request body — body associations item

Create — orders create Order — 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 type of association.
associations[]	Model	Each item	Expand Create — orders create Order — 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 characteristics of the CRM object being created. Additional keys: see wildcard field
properties.*	string	Additional keys

Referenced models: Create — orders create Order — request body — body associations item

Create — orders create Order — 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 Batch archive price book items — request body — body inputs item
types	array	Required within parent	An array of association specifications, each defining the category and type of the association between the objects.
types[]	Model	Each item	Expand Create — orders create Order — request body — body associations item types item

Referenced models: Batch archive price book items — request body — body inputs item, Create — orders create Order — request body — body associations item types item

Create — orders create Order — 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 within the defined category. Format: int32

Create — orders create Order — 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 on 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 their historical values, each with a timestamp. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — orders get Order — 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 Read — orders get Order — response body — warnings item

Referenced models: Read — orders get Order — response body — warnings item, Read — orders get Order — response body — properties With History value item

GDPR Delete — orders 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 field and must be provided as a string.

List associations — orders 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 — orders get Orders — response body — paging
results	array	Required within parent	An array of objects, each representing an association with multiple labels. Each object contains details about the associated object and the labels applied to the association.
results[]	Model	Each item	Expand List associations — orders get Associations By To Object Type — response body — results item

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

List associations — orders 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 containing details about the type and label of the association. Each item in the array is an object of type AssociationSpecWithLabel.
associationTypes[]	Model	Each item	Expand List associations — orders get Associations By To Object Type — response body — results item association Types item
toObjectId	string	Required within parent	The unique identifier of the object to which this object is associated. It is a string.

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

List associations — orders 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 'HUBSPOT_DEFINED', 'USER_DEFINED', 'INTEGRATOR_DEFINED', or '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 label that describes 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 type of association. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List — orders get Orders — 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 — orders get Orders — response body — paging
results	array	Required within parent	An array of SimplePublicObjectWithAssociations, each representing a CRM object with its properties and associations.
results[]	Model	Each item	Expand Read — orders get Order — response body

Referenced models: List — orders get Orders — response body — paging, Read — orders get Order — response body

List — orders get Orders — 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 — orders get Orders — response body — paging next

Referenced models: List — orders get Orders — response body — paging next

List — orders get Orders — 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 retrieve the next set of results in a paged response.
link	string	Optional	A string URL that points to the next page of results.

Read batch objects — orders batch Get Orders — 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 representing an object to be read.
inputs[]	Model	Each item	Expand Archive a batch of contacts — request body — body inputs item
properties	array	Required within parent	An array of strings specifying the properties to be returned in the response. If any of the specified properties are not present on the requested objects, they will be ignored.
properties[]	string	Each item
propertiesWithHistory	array	Required within parent	An array of strings specifying the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested objects, they will be ignored.
propertiesWithHistory[]	string	Each item

Referenced models: Archive a batch of contacts — request body — body inputs item

Read batch objects — orders.batchGetOrders — 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 key mapping to 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 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, which may contain 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 providing more specific categorization of the error.

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

Read batch objects — orders.batchGetOrders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Orders 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 information 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 — orders create Order — response body
startedAt	string	Required within parent	The date and time when the batch operation began, 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 — orders create Order — response body

Read batch objects — orders.batchGetOrders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Orders 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 items detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Read batch objects — orders.batchGetOrders — 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 SimplePublicObject items representing the results of the batch operation.
results[]	Model	Each item	Expand Create — orders create Order — 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: Read batch objects — orders.batchGetOrders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create — orders create Order — response body

Read — orders get Order — 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 — orders get Order — 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 CRM 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 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. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — orders get Order — 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 for accessing 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 — orders get Order — response body — warnings item

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

Read — orders get Order — 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 — orders search Orders — response body — paging
results	array	Required within parent	An array of associated IDs, each represented by an object containing the ID and type of the association.
results[]	Model	Each item	Expand Read — orders get Order — response body — associations value results item

Referenced models: Read — orders get Order — response body — associations value results item, Search — orders search Orders — response body — paging

Read — orders get Order — 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	A string representing the unique identifier of the associated object.
type	string	Required within parent	A string indicating the type of association for the object.

Read — orders get Order — 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 originates.
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 being recorded. It is represented as a string.

Read — orders get Order — 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 about the warning, with properties as key-value pairs where both keys and values are strings. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the message that describes the warning.

Search — orders search Orders — 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 of the last successfully read resource. This token is used for pagination to retrieve the next set of results.
filterGroups	array	Required within parent	An array of filter groups used to specify the search criteria. Each filter group contains multiple filters that define the conditions for the search.
filterGroups[]	Model	Each item	Expand Search — orders search Orders — request body — body filter Groups item
limit	integer	Required within parent	An integer specifying the maximum number of results to return. This value controls the page size of the search results. Format: int32
properties	array	Required within parent	An array of strings specifying the properties to be returned in the search results. If a specified property is not present on the requested object(s), it will be ignored.
properties[]	string	Each item
query	string	Optional	A string used to perform a full-text search across the specified properties.
sorts	array	Required within parent	An array of strings that define the sorting order of the search results. Each string specifies a property to sort by, optionally followed by a direction (e.g., 'propertyName ASC').
sorts[]	string	Each item

Referenced models: Search — orders search Orders — request body — body filter Groups item

Search — orders search Orders — 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 — orders search Orders — request body — body filter Groups item filters item

Referenced models: Search — orders search Orders — request body — body filter Groups item filters item

Search — orders search Orders — 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 of a range when using range-based operators like 'BETWEEN'.
operator	string	Required within parent	The operator that defines how the property value should be compared to the filter's value(s). Valid operators 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 specifies which object property the filter applies to.
value	string	Optional	The value to compare against the specified property. It is a string used in conjunction with the operator to determine if an object meets the filter criteria.
values	array	Optional	An array of strings representing multiple values to compare against the specified property. Used with operators that support multiple values, such as 'IN' or 'NOT_IN'.
values[]	string	Each item

Search — orders search Orders — 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 — orders search Orders — response body — paging
results	array	Required within parent	An array containing the simple public objects returned in the current response.
results[]	Model	Each item	Expand Create — orders create Order — 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 — orders search Orders — response body — paging, Create — orders create Order — response body

Search — orders search Orders — 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 — orders get Orders — response body — paging next
prev	Model	Optional	Expand Search — orders search Orders — response body — paging prev

Referenced models: List — orders get Orders — response body — paging next, Search — orders search Orders — response body — paging prev

Search — orders search Orders — 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, used to navigate to the previous set of results.
link	string	Optional	A string URL that provides a direct link to the previous page of results.

Update batch objects — orders batch Update Orders — 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 containing the data for a single object to be processed in the batch operation.
inputs[]	Model	Each item	Expand Update batch objects — orders batch Update Orders — request body — body inputs item

Referenced models: Update batch objects — orders batch Update Orders — request body — body inputs item

Update batch objects — orders batch Update Orders — 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, useful for debugging and tracking changes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are property values for the CRM object. Each property is represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys

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

Upsert batch objects — orders batch Upsert Orders — 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 containing the properties and identifiers needed for upserting a public object.
inputs[]	Model	Each item	Expand Upsert batch objects — orders batch Upsert Orders — request body — body inputs item

Referenced models: Upsert batch objects — orders batch Upsert Orders — request body — body inputs item

Upsert batch objects — orders batch Upsert Orders — 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 for the CRM object.
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 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 object. Each property is a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — orders.batchUpsertOrders — 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 CRM object is archived.
archivedAt	string	Optional	The date and time when the CRM object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the CRM object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the CRM object.
new	boolean	Required within parent	A boolean indicating whether the CRM object was newly created (true) or updated (false) during the upsert operation.
objectWriteTraceId	string	Optional	A unique identifier for tracing the write operation that created or updated the object.
properties	object	Required within parent	A map of property names to their current values for the CRM 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. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — orders get Order — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when the CRM object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL to access the CRM object.
warnings	array	Optional	An array of warnings related to the CRM object, each including a category, message, and context.
warnings[]	Model	Each item	Expand Read — orders get Order — response body — warnings item

Referenced models: Read — orders get Order — response body — warnings item, Read — orders get Order — response body — properties With History value item

Upsert batch objects — orders.batchUpsertOrders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Orders 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 context or resources 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 batch upsert operation.
results[]	Model	Each item	Expand Upsert batch objects — orders.batchUpsertOrders — 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 — orders.batchUpsertOrders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — orders.batchUpsertOrders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Orders 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 Read batch objects — orders.batchGetOrders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional information or resources 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 objects that were successfully upserted during the batch operation.
results[]	Model	Each item	Expand Upsert batch objects — orders.batchUpsertOrders — 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 — orders.batchGetOrders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Upsert batch objects — orders.batchUpsertOrders — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item