Skip to main content
POST
/
items
Create an item
curl --request POST \
  --url https://app.supercycle.com/api/v1/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shopifyVariantId": 123,
  "visibility": "available",
  "quantity": 99,
  "serials": [
    "<string>"
  ],
  "conditionId": "<unknown>",
  "locationShopifyId": "<unknown>",
  "pickLocation": "<unknown>"
}
'
[
  {
    "id": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "activeRentalId": "<unknown>",
    "productTitle": "<string>",
    "serial": "<unknown>",
    "sequentialId": 123,
    "shopifyVariantId": "<unknown>",
    "status": "processed",
    "tags": [
      "<string>"
    ],
    "variantTitle": "<unknown>",
    "visibility": "available",
    "activeReturnId": "<unknown>",
    "condition": "<unknown>",
    "conditionId": "<unknown>",
    "imageUrl": "<unknown>",
    "location": "<unknown>",
    "pickLocation": "<unknown>",
    "shopifyProductId": "<unknown>",
    "timelineEvents": [
      {
        "id": 123,
        "eventableId": 123,
        "eventableType": "<string>",
        "eventType": "<string>",
        "metadata": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "author": "<string>"
      }
    ]
  }
]

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.

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
object
​
conditionId
null | integer

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

​
imageUrl
null | string
​
location
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.

​
shopifyProductId
null | integer
​
timelineEvents
object[]

Timeline events for this item