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,
  "quantity": 99,
  "serials": [
    "<string>"
  ],
  "visibility": "available",
  "conditionId": null,
  "locationShopifyId": null,
  "pickLocation": null
}'
[
  {
    "id": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "activeRentalId": null,
    "activeReturnId": null,
    "condition": null,
    "conditionId": null,
    "imageUrl": null,
    "location": null,
    "pickLocation": null,
    "productTitle": "<string>",
    "serial": null,
    "sequentialId": 123,
    "shopifyProductId": null,
    "shopifyVariantId": null,
    "status": "processed",
    "tags": [
      "<string>"
    ],
    "variantTitle": null,
    "visibility": "available",
    "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
required
​
visibility
enum<string>
required
Available options:
available,
unavailable,
retired,
sold
​
quantity
integer

Number of items to create.

Required range: x <= 100
​
serials
string[]

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

​
conditionId
integer | null

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

​
locationShopifyId
integer | null

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

​
pickLocation
string | null

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
required

Numeric ID of the item.

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

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

​
imageUrl
string | null
​
location
object | null

Location of the item in the warehouse.

​
pickLocation
string | null

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
integer | null
​
timelineEvents
object[]

Timeline events for this item