Update an inventory item

Requires write_inventory access scope.

For more info, refer to:

PUT https://{handle}.myshopline.com/admin/openapi/v20260301/inventory_items/:inventory_item_id.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Update the information of a specified inventory item.

Path Parameters

inventory_item_id string required

The unique identifier for the inventory item.
Maximum length：64

Example: 5703943240925324252

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

inventory_itemobject required

Inventory item information.
cost string

The cost price of the variant. The value is rounded to two decimal places.
Default value: 0
Example: 10.91
required_shipping boolean

Indicates whether the variant is required to be shipped.

true: Shipping is required.

false: Shipping is not required.

Default value: true
sku string

The product SKU.
Maximum size: 255
Example: K00000001
tracked boolean

Indicates whether the inventory tracking is enabled.

true: Inventory tracking is enabled.

false: Inventory tracking is not enabled.

Default value: true

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

inventory_itemobject

Inventory item information.
cost string

The cost price of the variant. The value is rounded to two decimal places.
Example: 10.9
created_at string

The date and time when the inventory item was created. Format: ISO 8601.
Example: 2022-12-06T20:23:06+08:00
id string

The unique identifier for the inventory item.
Example: 5703943989105270965
required_shipping boolean

Indicates whether the variant is required to be shipped.

true: Shipping is required.

false: Shipping is not required.
sku string

The product SKU. It is distinct from variant.id returned by SHOPLINE.
Example: K00000001
tracked boolean

Indicates whether the inventory tracking is enabled.

true: Inventory tracking is enabled.

false: Inventory tracking is not enabled.
updated_at string

The date and time when the inventory item was last updated. Format: ISO 8601.
Example: 2022-12-06T20:23:06+08:00
variant_id string

The unique identifier for the variant.
Example: 18057039432358082693350282

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

inventory_item_id — path required

Authorization — header required

Body

Body required

{
  "inventory_item": {
    "cost": "10.91",
    "required_shipping": null,
    "sku": "K00000001",
    "tracked": null
  }
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/inventory_items/inventory_item_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal