Skip to main content
POST
Create an item

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
shopifyVariantId
integer<int64>
required
visibility
enum<string>
required
Available options:
available,
unavailable,
retired,
sold
quantity
integer<int32>

Number of items to create.

Required range: x <= 100
serials
string[]

Serials will be picked from the list and assigned to items.

conditionId
null | integer<int64>

ID of the condition to set. May be null to remove condition.

locationShopifyId
null | integer<int64>

ID of the Shopify location to associate with the item. May be null if no specific location is needed.

pickLocation
null | string

Physical location within warehouse using Zone-Aisle-Shelf-Bin format (e.g., "A1-02-B3"). May be null if no pick location is needed.

acquisitionCostCents
null | integer

Amount paid to acquire each new item, in cents. Applied to every created item when quantity > 1. May be null if not known yet.

Response

Expected response to a valid request

id
integer<int64>
required

Numeric ID of the item.

createdAt
string<date-time>
required
activeRentalId
null | integer<int64>
required
productTitle
string
required
serial
null | string
required
sequentialId
integer<int32>
required
shopifyVariantId
null | integer
required
status
enum<string>
required
Available options:
processed,
unprocessed
tags
string[]
required
variantTitle
null | string
required
visibility
enum<string>
required
Available options:
available,
unavailable,
sold,
retired
activeReturnId
null | integer<int64>
condition
null | object
conditionId
null | integer

ID of the condition. May be null if no condition is set.

imageUrl
null | string
location
null | object

Location of the item in the warehouse.

pickLocation
null | string

Physical location within warehouse using Zone-Aisle-Shelf-Bin format (e.g., "A1-02-B3"). May be null if no pick location is set.

acquisitionCostCents
null | integer

Amount paid to acquire this item, in cents. May be null if not set.

roiCents
null | integer

Computed return on investment (lifecycle revenue minus acquisition cost), in cents. Null when acquisitionCostCents is null.

shopifyProductId
null | integer
timelineEvents
object[]

Timeline events for this item

customFields
object[]

Custom fields attached to this item