POST
/
api
/
KarizClientApp
/
Unified
/
Inventory
curl --request POST \
  --url https://api.trykariz.com/api/KarizClientApp/Unified/Inventory \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "params": {
    "shopify": [
      {
        "key": "baseUrl",
        "value": "your-shop.myshopify.com"
      },
      {
        "key": "token",
        "value": "your-shopify-oauth-token"
      }
    ]
  },
  "inventory_item_ids": "808950810,457924702,908978021",
  "limit": 100,
  "location_ids": "655441491,487838322",
  "updated_at_min": "2023-11-01T08:30:00-05:00"
}'
{
  "Errors": {},
  "Output": {
    "step": "transform",
    "isSuccess": true,
    "schemaValidationErrors": null,
    "restErrors": null,
    "operationErrors": null,
    "unexpectedErrors": null,
    "execution_id": "ed7ad663-4757-447c-b5cd-1e83c2380afc",
    "override_count": 1,
    "next_page_token_url": "https://api.trykariz.com/api/KarizClientApp/RunSync?configName=shopify_get_orders&tpUserId=1&data=%7B%22limit%22%3A1%2C%22next_page_token%22%3A%22eyJsYXN0X2lkIjo1OTU0NDYxMzM1ODI3LCJsYXN0X3ZhbHVlIjoiMjAyNC0wOS0xMyAxNDo0NzoxMy4xNDAwNTEiLCJkaXJlY3Rpb24iOiJuZXh0In0%22%7D",
    "next_page_token": "eyJsYXN0X2lkIjo1OTU0NDYxMzM1ODI3LCJsYXN0X3ZhbHVlIjoiMjAyNC0wOS0xMyAxNDo0NzoxMy4xNDAwNTEiLCJkaXJlY3Rpb24iOiJuZXh0In0",
    "result": {
      "inventory_levels": [
        {
          "inventory_item_id": 49148385,
          "location_id": 655441491,
          "available": 2,
          "updated_at": "2025-01-08T16:01:01-05:00",
          "admin_graphql_api_id": "gid://shopify/InventoryLevel/655441491?inventory_item_id=49148385"
        },
        {
          "inventory_item_id": 808950810,
          "location_id": 655441491,
          "available": 1,
          "updated_at": "2025-01-08T16:01:01-05:00",
          "admin_graphql_api_id": "gid://shopify/InventoryLevel/655441491?inventory_item_id=808950810"
        },
        {
          "inventory_item_id": 457924702,
          "location_id": 655441491,
          "available": 4,
          "updated_at": "2025-01-08T16:01:01-05:00",
          "admin_graphql_api_id": "gid://shopify/InventoryLevel/655441491?inventory_item_id=457924702"
        },
        {
          "inventory_item_id": 39072856,
          "location_id": 655441491,
          "available": 3,
          "updated_at": "2025-01-08T16:01:01-05:00",
          "admin_graphql_api_id": "gid://shopify/InventoryLevel/655441491?inventory_item_id=39072856"
        }
      ]
    }
  },
  "Report": {
    "TraceId": "00-3c6a96b919427b0952ba274800a4b04f-7efc4603f4ee42e7-00",
    "TotalExtResourcesDuration": 356.8311,
    "TotalEventsTransitDuration": 554.5615,
    "TotalTransformationsDuration": 690.4757,
    "TotalRequestsDuration": 4296.1973,
    "ExtResources": [
      {
        "Uri": "https://quickstart.myshopify.com/admin/api/2025-01/inventory_levels.json",
        "Duration": 356.8311
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
channel
enum<string>
required

Specify the sales channel from which to fetch user data. Each request can only retrieve data from a single channel at a time. Since requests are processed in real-time, response times vary depending on the sales channel’s speed

Available options:
shopify
​
tpUserId
string
required

The ID of your user(must be authenticated with target channels).

​
completionCallbackUrl
string

To receive the completion event. You can use a webhook to find out whether the task is finished.

Body

application/json

The supported parameters to query the data depend on the channels API. Supported channels shows which parameters can be used for which channels.

​
inventory_item_ids
string

A comma-separated list of inventory item IDs. To find the ID of an inventory item, use the Inventory Item resource

​
limit
number | null
default:1

The maximum number of results to show.

​
location_ids
string

A comma-separated list of location IDs. To find the ID of a location, use the Location resource

​
updated_at_min
string

Show inventory levels updated at or after date (format: 2019-03-19T01:21:44-04:00).

​
next_page_token
string | null

Used to paginate to the next batch of objects. Should be a copy of the next_page_token value from the previous response.

Supported channels: shopify, woocommerce, bigcommerce, lightspeed_c, bol, amazon, magento

​
params
object

Response

200 - application/json

POST /Unified/Inventory Successful response

​
Errors
object
required
​
Output
object
required
​
Report
object
required