Get an inventory item

Requires read_inventory access scope.

For more info, refer to:

GET https://{handle}.myshopline.com/admin/openapi/v20261201/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 .

Get an 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 eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

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.
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: K00000000001
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
cost string

The cost price of the variant. The value is rounded to two decimal places.
Example: 10.91
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: 5703943240925324252

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

inventory_item_id — path required

Authorization — header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/inventory_items/inventory_item_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal