Skip to main content
POST
Batch create price book items

Supported products

Path Parameters

priceBookId
integer<int64>
required

The unique identifier of the price book to which the items will be added.

Body

application/json
inputs
object[]
required

An array of PriceBookAddProductRequest objects, each representing a product to be added to the price book. This property is required.

Response

successful operation

completedAt
string<date-time>
required

The date and time when the batch operation was completed, in ISO 8601 format.

results
object[]
required

An array of PriceBookItemResponse objects representing the individual results of the batch operation.

startedAt
string<date-time>
required

The date and time when the batch operation started, in ISO 8601 format.

status
enum<string>
required

The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

A map of link names to associated URIs providing additional information or actions related to the batch operation.

requestedAt
string<date-time>

The date and time when the batch operation was requested, in ISO 8601 format.

Last modified on September 9, 2026