PUT
/
items
/
{item_id}
curl --request PUT \
  --url https://app.supercycle.com/api/v1/items/{item_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "serial": null,
  "shopifyVariantId": null,
  "status": "processed",
  "visibility": "available",
  "conditionId": null,
  "location_shopify_id": null
}'
{
  "id": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "activeRentalId": null,
  "condition": null,
  "conditionId": null,
  "imageUrl": null,
  "location_shopify_id": null,
  "productTitle": "<string>",
  "serial": null,
  "sequentialId": 123,
  "shopifyProductId": null,
  "shopifyVariantId": null,
  "status": "processed",
  "tags": [
    "<string>"
  ],
  "variantTitle": null,
  "visibility": "available",
  "timeline_events": [
    {
      "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.

Path Parameters

​
item_id
integer
required

Numeric ID of the item to retrieve.

Body

application/json
​
serial
string | null
​
shopifyVariantId
integer | null
​
status
enum<string>
Available options:
processed,
unprocessed
​
visibility
enum<string>
Available options:
available,
unavailable,
retired,
sold
​
conditionId
integer | null

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

​
location_shopify_id
integer | null

ID of the Shopify location to associate with the item. May be null to remove location assignment.

Response

200
application/json

Expected response to a valid request

​
id
integer
required

Numeric ID of the item.

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

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

​
imageUrl
string | null
​
location_shopify_id
integer | null

ID of the Shopify location where the item is stored. May be null if no location is set.

​
shopifyProductId
integer | null
​
timeline_events
object[]

Timeline events for this item