Skip to content

HubSpot: Batch archive price book items

HubSpot priceBooks.batchArchivePriceBookItems: arguments, response, policy and SDK examples.

← Price books operations · Get started

Operation hubspot.price_books_batch_archive_price_book_items

Provider route: POST /commerce/price-books/2026-09/price-books/{priceBookId}/items/batch/archive. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";
async function execute(input: Parameters<HubSpotIntegration["priceBooks"]["batchArchivePriceBookItems"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.priceBooks.batchArchivePriceBookItems(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.price_books.batch_archive_price_book_items(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.priceBookIdintegerRequired within parentFormat: int64
bodyModelRequired within parentExpand Batch archive price book items — request body — body

Referenced models: Batch archive price book items — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Batch archive price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING
$ (anyOf 2)nullAlternative

Referenced models: Batch archive price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING

Batch archive price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING
FieldTypePresenceDescription and constraints
$objectRoot
completedAtstringRequired within parentFormat: date-time
errorsarrayOptional
errors[]ModelEach itemExpand Batch create price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
linksobjectOptionalAdditional keys: see wildcard field
links.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeFormat: int32
numErrors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAtstringOptionalFormat: date-time
resultsarrayRequired within parent
results[]ModelEach itemExpand Batch archive price book items — request body — body inputs item
startedAtstringRequired within parentFormat: date-time
statusstringRequired within parentKnown values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Batch archive price book items — request body — body inputs item, Batch create price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Batch archive price book items — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
inputsarrayRequired within parentAn array of SimplePublicObjectId objects, each representing a unique identifier for a public object. This property is required and is used to specify the objects involved in the batch operation.
inputs[]ModelEach itemExpand Batch archive price book items — request body — body inputs item

Referenced models: Batch archive price book items — request body — body inputs item

Batch archive price book items — request body — body inputs item
FieldTypePresenceDescription and constraints
$objectRootContains the Id of a Public Object
idstringRequired within parentThe unique identifier for this object, represented as a string.
Batch create price book items — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
FieldTypePresenceDescription and constraints
$objectRootYe olde error
categorystringRequired within parentA string specifying the category of the error.
contextobjectRequired within parentAn object containing additional context about the error, with each key mapping to an array of strings.
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
errorsarrayRequired within parentAn array of ErrorDetail objects providing further information about the error.
errors[]ModelEach itemExpand Validate price book — response body — errors item
idstringOptionalA string representing the unique identifier of the error.
linksobjectRequired within parentAn object mapping link names to URIs that provide documentation or remediation steps related to the error.
Additional keys: see wildcard field
links.*stringAdditional keys
messagestringRequired within parentA string containing a human-readable message that describes the error.
statusstringRequired within parentA string indicating the status of the error.
subCategoryobjectOptionalAn object providing more specific details about the error category.

Referenced models: Validate price book — response body — errors item

Validate price book — response body — errors item
FieldTypePresenceDescription and constraints
$objectRootRepresents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
codestringOptionalThe status code associated with the error detail.
contextobjectOptionalContext about the error condition, which may include additional information such as missing scopes or invalid property names.
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
instringOptionalThe name of the field or parameter in which the error was found.
messagestringRequired within parentA human readable message describing the error along with remediation steps where appropriate. This is a required property.
subCategorystringOptionalA specific category that contains more specific detail about the error.

SDK function policy ID: hubspot.price_books_batch_archive_price_book_items. Catalog operation: price_books_batch_archive_price_book_items. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["cpq.price_books.write"]

No-content response statuses: [204]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.