POST
/
api
/
KarizClientApp
/
Unified
/
Products
curl --request POST \
  --url https://api.trykariz.com/api/KarizClientApp/Unified/Products \
  --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"
      }
    ]
  },
  "collection_id": "1",
  "created_at_max": "1948-06-08T07:16:01.0Z",
  "created_at_min": "1948-06-08T07:16:01.0Z",
  "fields": "id,name",
  "handle": "handle",
  "ids": "1,2",
  "limit": 10,
  "product_type": "1948-06-08T07:16:01.0Z",
  "published_at_max": "1948-06-08T07:16:01.0Z",
  "published_at_min": "1948-06-08T07:16:01.0Z",
  "published_status": "published",
  "since_id": "1",
  "status": "active",
  "title": "title",
  "updated_at_max": "1918-04-30T21:13:27.0Z",
  "updated_at_min": "1918-04-30T21:13:27.0Z",
  "vendor": "vendor"
}'
{
  "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": [
      {
        "id": "9193872097555",
        "channel_name": "lightspeed_c",
        "title": "Gift Card",
        "body_html": "This is a gift card for the store",
        "vendor": "Snowboard Vendor",
        "product_type": "",
        "created_at": "2024-03-29T09:40:33+00:00",
        "handle": "gift-card",
        "updated_at": "2024-04-19T17:37:08+00:00",
        "published_at": "2024-03-29T09:40:34+00:00",
        "template_suffix": null,
        "published_scope": "web",
        "tags": "",
        "status": "active",
        "variants": [
          {
            "id": "48467551060243",
            "product_id": "9193872097555",
            "title": "$10",
            "price": "10.00",
            "position": 1,
            "inventory_policy": "deny",
            "compare_at_price": null,
            "option1": "$10",
            "option2": null,
            "option3": null,
            "created_at": "2024-03-29T09:40:33+00:00",
            "updated_at": "2024-03-29T09:40:33+00:00",
            "taxable": false,
            "barcode": null,
            "fulfillment_service": "gift_card",
            "grams": 0,
            "inventory_management": null,
            "requires_shipping": false,
            "sku": "",
            "weight": 0,
            "weight_unit": "kg",
            "inventory_item_id": "50485600059667",
            "inventory_quantity": 0,
            "old_inventory_quantity": 0,
            "image_id": null,
            "inventory_item": {
              "id": "50485600059667",
              "sku": "",
              "created_at": "2024-03-29T09:40:33+00:00",
              "updated_at": "2024-03-29T09:40:33+00:00",
              "requires_shipping": false,
              "cost": null,
              "country_code_of_origin": null,
              "province_code_of_origin": null,
              "harmonized_system_code": null,
              "tracked": false,
              "inventory_levels": [
                {
                  "inventory_item_id": "50485600059667",
                  "location_id": "97423720723",
                  "available": null,
                  "updated_at": "2024-03-29T09:40:34+00:00"
                }
              ]
            }
          },
          {
            "id": "48467551093011",
            "product_id": "9193872097555",
            "title": "$25",
            "price": "25.00",
            "position": 2,
            "inventory_policy": "deny",
            "compare_at_price": null,
            "option1": "$25",
            "option2": null,
            "option3": null,
            "created_at": "2024-03-29T09:40:33+00:00",
            "updated_at": "2024-03-29T09:40:33+00:00",
            "taxable": false,
            "barcode": null,
            "fulfillment_service": "gift_card",
            "grams": 0,
            "inventory_management": null,
            "requires_shipping": false,
            "sku": "",
            "weight": 0,
            "weight_unit": "kg",
            "inventory_item_id": "50485600092435",
            "inventory_quantity": 0,
            "old_inventory_quantity": 0,
            "image_id": null,
            "inventory_item": {
              "id": "50485600092435",
              "sku": "",
              "created_at": "2024-03-29T09:40:33+00:00",
              "updated_at": "2024-03-29T09:40:33+00:00",
              "requires_shipping": false,
              "cost": null,
              "country_code_of_origin": null,
              "province_code_of_origin": null,
              "harmonized_system_code": null,
              "tracked": false,
              "inventory_levels": [
                {
                  "inventory_item_id": "50485600092435",
                  "location_id": "97423720723",
                  "available": null,
                  "updated_at": "2024-03-29T09:40:34+00:00"
                }
              ]
            }
          },
          {
            "id": "48467551158547",
            "product_id": "9193872097555",
            "title": "$50",
            "price": "50.00",
            "position": 3,
            "inventory_policy": "deny",
            "compare_at_price": null,
            "option1": "$50",
            "option2": null,
            "option3": null,
            "created_at": "2024-03-29T09:40:33+00:00",
            "updated_at": "2024-03-29T09:40:33+00:00",
            "taxable": false,
            "barcode": null,
            "fulfillment_service": "gift_card",
            "grams": 0,
            "inventory_management": null,
            "requires_shipping": false,
            "sku": "",
            "weight": 0,
            "weight_unit": "kg",
            "inventory_item_id": "50485600125203",
            "inventory_quantity": 0,
            "old_inventory_quantity": 0,
            "image_id": null,
            "inventory_item": {
              "id": "50485600125203",
              "sku": "",
              "created_at": "2024-03-29T09:40:33+00:00",
              "updated_at": "2024-03-29T09:40:33+00:00",
              "requires_shipping": false,
              "cost": null,
              "country_code_of_origin": null,
              "province_code_of_origin": null,
              "harmonized_system_code": null,
              "tracked": false,
              "inventory_levels": [
                {
                  "inventory_item_id": "50485600125203",
                  "location_id": "97423720723",
                  "available": null,
                  "updated_at": "2024-03-29T09:40:34+00:00"
                }
              ]
            }
          },
          {
            "id": "48467551191315",
            "product_id": "9193872097555",
            "title": "$100",
            "price": "100.00",
            "position": 4,
            "inventory_policy": "deny",
            "compare_at_price": null,
            "option1": "$100",
            "option2": null,
            "option3": null,
            "created_at": "2024-03-29T09:40:33+00:00",
            "updated_at": "2024-03-29T09:40:33+00:00",
            "taxable": false,
            "barcode": null,
            "fulfillment_service": "gift_card",
            "grams": 0,
            "inventory_management": null,
            "requires_shipping": false,
            "sku": "",
            "weight": 0,
            "weight_unit": "kg",
            "inventory_item_id": "50485600157971",
            "inventory_quantity": 0,
            "old_inventory_quantity": 0,
            "image_id": null,
            "inventory_item": {
              "id": "50485600157971",
              "sku": "",
              "created_at": "2024-03-29T09:40:33+00:00",
              "updated_at": "2024-03-29T09:40:33+00:00",
              "requires_shipping": false,
              "cost": null,
              "country_code_of_origin": null,
              "province_code_of_origin": null,
              "harmonized_system_code": null,
              "tracked": false,
              "inventory_levels": [
                {
                  "inventory_item_id": "50485600157971",
                  "location_id": "97423720723",
                  "available": null,
                  "updated_at": "2024-03-29T09:40:34+00:00"
                }
              ]
            }
          }
        ],
        "options": [
          {
            "id": "11557505007891",
            "product_id": "9193872097555",
            "name": "Denominations",
            "position": 1,
            "values": [
              "$10",
              "$25",
              "$50",
              "$100"
            ]
          }
        ],
        "images": [
          {
            "id": "45574246203667",
            "alt": "Gift card that shows text: Generated data gift card",
            "position": 1,
            "product_id": "9193872097555",
            "created_at": "2024-03-29T09:40:33+00:00",
            "updated_at": "2024-03-29T09:40:33+00:00",
            "width": 2881,
            "height": 2881,
            "src": "https://cdn.shopify.com/s/files/1/0870/1234/4083/files/gift_card.png?v=1711705233",
            "variant_ids": []
          }
        ]
      }
    ]
  },
  "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/2024-04/orders.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:
bigcommerce,
bol,
lightspeed_c,
magento,
mirakl,
shopify,
woocommerce
​
tpUserId
string
required

The ID of the user you want to fetch the data for. The user must be authenticated to the channel you are sending the request for.

​
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.

​
next_page_token
string

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

​
limit
number
default:10

Used to limit the number of returned objects. The maximum is 100.

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

​
updated_at_min
string<date-time>

Return products updated after this date. Date must be in ISO 8601 format (YYYY-MM-DDTHH:mm:ss[timezone offset]).

Supported channels: shopify, bigcommerce, lightspeed_c

Example:

"2025-01-25T16:15:47-04:00"

​
updated_at_max
string<date-time>

Return products updated before this date. Date must be in ISO 8601 format (YYYY-MM-DDTHH:mm:ss[timezone offset])

Supported channels: shopify, bigcommerce, lightspeed_c

Example:

"2025-01-25T16:15:47-04:00"

​
created_at_min
string<date-time>

Return products created after this date. Date must be in ISO 8601 format (YYYY-MM-DDTHH:mm:ss[timezone offset])

Supported channels: shopify, lightspeed_c

Example:

"2025-01-25T16:15:47-04:00"

​
created_at_max
string<date-time>

Return products created before this date. Date must be in ISO 8601 format (YYYY-MM-DDTHH:mm:ss[timezone offset]).

Supported channels: shopify, lightspeed_c

Example:

"2025-01-25T16:15:47-04:00"

​
published_at_min
string<date-time>

Return products published after this date. Date must be in ISO 8601 format (YYYY-MM-DDTHH:mm:ss[timezone offset]).

Supported channels: shopify, woocommerce

Example:

"2025-01-25T16:15:47-04:00"

​
published_at_max
string<date-time>

Return products published before this date. Date must be in ISO 8601 format (YYYY-MM-DDTHH:mm:ss[timezone offset]).

Supported channels: shopify, woocommerce

Example:

"2025-01-25T16:15:47-04:00"

​
published_status
enum<string>
default:any

Return products by their published status.

Supported channels: shopify

Available options:
published,
unpublished,
any
​
ids
string

Return only products specified by a comma-separated list of product IDs.

Supported channels: shopify, woocommerce, magento

​
status
enum<string>
default:any

Return only products specified by a comma-separated list of statuses.

Supported channels: shopify, woocommerce

Available options:
active,
archived,
draft
​
since_id
string

Return only products after the specified ID.

Supported channels: shopify,lightspeed_c

​
fields
string

Return only certain fields specified by a comma-separated list of field names.

Supported channels: shopify,lightspeed_c

​
collection_id
string

Return products by product collection ID.

Supported channels: shopify, woocommerce, magento

​
handle
string

Return only products specified by a comma-separated list of product handles.

Supported channels: shopify, magento

​
product_type
string

Return products by product type.

Supported channels: shopify

​
title
string

Return products by product title.

Supported channels: shopify, woocommerce, magento

​
vendor
string

Return products by product vendor.

Supported channels: shopify,lightspeed_c

​
params
object

Response

200 - application/json

POST /Unified/Products Successful response

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