POST
/
api
/
KarizClientApp
/
Unified
/
Orders
curl --request POST \
  --url https://api.trykariz.com/api/KarizClientApp/Unified/Orders \
  --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"
      }
    ]
  },
  "api_version": "1",
  "attribution_app_id": "1",
  "created_at_max": "1948-06-08T07:16:01.0Z",
  "created_at_min": "1948-06-08T07:16:01.0Z",
  "fields": "id,name",
  "financial_status": "paid",
  "fulfillment_status": "shipped",
  "ids": "1,2",
  "limit": 10,
  "processed_at_max": "1948-06-08T07:16:01.0Z",
  "processed_at_min": "1948-06-08T07:16:01.0Z",
  "since_id": "1",
  "status": "any",
  "updated_at_max": "1918-04-30T21:13:27.0Z",
  "updated_at_min": "1939-08-05T01:34:33.0Z"
}'
{
  "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": "5954461335827",
        "channel_name": "shopify",
        "app_id": "1354745",
        "billing_address": {
          "id": null,
          "channel_name": "shopify",
          "address1": "address1",
          "address2": "E",
          "city": "Amsterdam",
          "company": "Kariz",
          "country": "Netherlands",
          "country_code": "NL",
          "first_name": "first_name",
          "last_name": "last_name",
          "name": "name",
          "phone": "+31629362580",
          "province": null,
          "province_code": null,
          "zip": "2311 EA"
        },
        "buyer_accepts_marketing": true,
        "cancel_reason": null,
        "cancelled_at": null,
        "checkout_id": "38277296718099",
        "closed_at": null,
        "confirmed": true,
        "created_at": "2024-09-13T14:47:13+00:00",
        "currency": "EUR",
        "customer": {
          "id": "8430809743635",
          "created_at": "2024-09-13T14:43:08+00:00",
          "default_address": {
            "id": "10229148320019",
            "address1": "address1",
            "address2": "E",
            "city": "Amsterdam",
            "company": "Kariz",
            "country": "Netherlands",
            "country_code": "NL",
            "country_name": "Netherlands",
            "default": true,
            "first_name": "first_name",
            "last_name": "last_name",
            "name": "name",
            "phone": "phone",
            "province": null,
            "province_code": null,
            "zip": "zip"
          },
          "email": "h.sarlak20@gmail.com",
          "first_name": "first_name",
          "last_name": "last_name",
          "note": null,
          "phone": null,
          "tags": "",
          "tax_exempt": false,
          "tax_exemptions": [],
          "updated_at": "2024-09-13T14:47:13+00:00",
          "verified_email": true,
          "sms_marketing_consent": {},
          "email_marketing_consent": {
            "state": "subscribed",
            "opt_in_level": "single_opt_in",
            "consent_updated_at": "2024-09-13T14:43:08+00:00"
          }
        },
        "customer_locale": "en",
        "device_id": null,
        "discount_codes": [
          {
            "id": null,
            "amount": "4.95",
            "code": "FREESHIPPING2024",
            "type": "shipping"
          }
        ],
        "discount_applications": [
          {
            "type": "discount_code",
            "code": "FREESHIPPING2024",
            "value": "100.0",
            "value_type": "percentage",
            "allocation_method": "each",
            "target_selection": "all",
            "target_type": "shipping_line"
          }
        ],
        "email": "h.sarlak20@gmail.com",
        "financial_status": "paid",
        "fulfillment_status": null,
        "phone": null,
        "tags": "",
        "line_items": [
          {
            "id": "15101787734291",
            "fulfillable_quantity": 1,
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "grams": 57,
            "price": "24.95",
            "product_id": "9193872326931",
            "quantity": 1,
            "requires_shipping": true,
            "sku": "",
            "title": "Selling Plans Ski Wax",
            "variant_id": "48467551420691",
            "variant_title": "Selling Plans Ski Wax",
            "name": "Selling Plans Ski Wax - Selling Plans Ski Wax",
            "vendor": "Quickstart (5676026b)",
            "gift_card": false,
            "taxable": true,
            "total_discount": "0.00",
            "total_discount_set": {
              "shop_money": {
                "currency_code": "EUR",
                "amount": "0.00"
              },
              "presentment_money": {
                "currency_code": "EUR",
                "amount": "0.00"
              }
            },
            "product_exists": true,
            "price_set": {
              "shop_money": {
                "currency_code": "EUR",
                "amount": "24.95"
              },
              "presentment_money": {
                "currency_code": "EUR",
                "amount": "24.95"
              }
            },
            "fulfillment_line_item_id": null
          },
          {
            "id": "15101787767059",
            "fulfillable_quantity": 1,
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "grams": 71,
            "price": "49.95",
            "product_id": "9193872326931",
            "quantity": 1,
            "requires_shipping": true,
            "sku": "",
            "title": "Selling Plans Ski Wax",
            "variant_id": "48467551453459",
            "variant_title": "Special Selling Plans Ski Wax",
            "name": "Selling Plans Ski Wax - Special Selling Plans Ski Wax",
            "vendor": "Quickstart (5676026b)",
            "gift_card": false,
            "taxable": true,
            "total_discount": "0.00",
            "total_discount_set": {
              "shop_money": {
                "currency_code": "EUR",
                "amount": "0.00"
              },
              "presentment_money": {
                "currency_code": "EUR",
                "amount": "0.00"
              }
            },
            "product_exists": true,
            "price_set": {
              "shop_money": {
                "currency_code": "EUR",
                "amount": "49.95"
              },
              "presentment_money": {
                "currency_code": "EUR",
                "amount": "49.95"
              }
            },
            "fulfillment_line_item_id": null
          },
          {
            "id": "15101787799827",
            "fulfillable_quantity": 1,
            "fulfillment_service": "manual",
            "fulfillment_status": null,
            "grams": 14,
            "price": "9.95",
            "product_id": "9193872326931",
            "quantity": 1,
            "requires_shipping": true,
            "sku": "",
            "title": "Selling Plans Ski Wax",
            "variant_id": "48467551486227",
            "variant_title": "Sample Selling Plans Ski Wax",
            "name": "Selling Plans Ski Wax - Sample Selling Plans Ski Wax",
            "vendor": "Quickstart (5676026b)",
            "gift_card": false,
            "taxable": true,
            "total_discount": "0.00",
            "total_discount_set": {
              "shop_money": {
                "currency_code": "EUR",
                "amount": "0.00"
              },
              "presentment_money": {
                "currency_code": "EUR",
                "amount": "0.00"
              }
            },
            "product_exists": true,
            "price_set": {
              "shop_money": {
                "currency_code": "EUR",
                "amount": "9.95"
              },
              "presentment_money": {
                "currency_code": "EUR",
                "amount": "9.95"
              }
            },
            "fulfillment_line_item_id": null
          }
        ],
        "location_id": null,
        "name": "#1004",
        "note": null,
        "number": "4",
        "order_number": "1004",
        "order_status_url": "https://quickstart-5676026b.myshopify.com/87012344083/orders/9f3c5659f7a47af9c3e32fc46ef0948f/authenticate?key=99cb5af1f58f1bcb43f592c724cbce36",
        "payment_gateway_names": [
          "manual"
        ],
        "processed_at": "2024-09-13T14:47:12+00:00",
        "referring_site": null,
        "shipping_address": {
          "id": null,
          "address1": "address1",
          "address2": "address2",
          "city": "Amsterdam",
          "company": "Kariz",
          "country": "Netherlands",
          "country_code": "NL",
          "first_name": "first_name",
          "last_name": "last_name",
          "name": "name",
          "phone": "phone",
          "province": null,
          "province_code": null,
          "zip": "zip"
        },
        "shipping_lines": [
          {
            "id": "4798704550163",
            "carrier_identifier": "4084464f694a06e6683c491d00cef27f",
            "code": "Standaard",
            "is_removed": false,
            "phone": null,
            "price": "4.95",
            "discounted_price": "4.95",
            "discount_allocations": [
              {
                "amount": "4.95",
                "discount_application_index": 0,
                "amount_set": {
                  "shop_money": {
                    "currency_code": "EUR",
                    "amount": "4.95"
                  },
                  "presentment_money": {
                    "currency_code": "EUR",
                    "amount": "4.95"
                  }
                }
              }
            ],
            "source": "shopify",
            "title": "Standaard",
            "price_set": {
              "shop_money": {
                "currency_code": "EUR",
                "amount": "4.95"
              },
              "presentment_money": {
                "currency_code": "EUR",
                "amount": "4.95"
              }
            },
            "discounted_price_set": {
              "shop_money": {
                "currency_code": "EUR",
                "amount": "4.95"
              },
              "presentment_money": {
                "currency_code": "EUR",
                "amount": "4.95"
              }
            }
          }
        ],
        "source_identifier": "9eb0dba16b98dda9011517e5880b0263",
        "source_name": "shopify_draft_order",
        "subtotal_price": "84.85",
        "taxes_included": true,
        "test": false,
        "total_discounts": "4.95",
        "total_line_items_price": "84.85",
        "total_tip_received": "0.00",
        "total_price": "84.85",
        "total_tax": "0.00",
        "total_weight": 142,
        "updated_at": "2024-09-13T14:47:14+00:00",
        "user_id": "109876314387",
        "current_total_duties_set": {},
        "original_total_duties_set": {},
        "presentment_currency": "EUR",
        "total_line_items_price_set": {
          "shop_money": {
            "currency_code": "EUR",
            "amount": "84.85"
          },
          "presentment_money": {
            "currency_code": "EUR",
            "amount": "84.85"
          }
        },
        "total_discounts_set": {
          "shop_money": {
            "currency_code": "EUR",
            "amount": "4.95"
          },
          "presentment_money": {
            "currency_code": "EUR",
            "amount": "4.95"
          }
        },
        "total_shipping_price_set": {
          "shop_money": {
            "currency_code": "EUR",
            "amount": "4.95"
          },
          "presentment_money": {
            "currency_code": "EUR",
            "amount": "4.95"
          }
        },
        "subtotal_price_set": {
          "shop_money": {
            "currency_code": "EUR",
            "amount": "84.85"
          },
          "presentment_money": {
            "currency_code": "EUR",
            "amount": "84.85"
          }
        },
        "total_price_set": {
          "shop_money": {
            "currency_code": "EUR",
            "amount": "84.85"
          },
          "presentment_money": {
            "currency_code": "EUR",
            "amount": "84.85"
          }
        },
        "total_outstanding": "0.00",
        "total_tax_set": {
          "shop_money": {
            "currency_code": "EUR",
            "amount": "0.00"
          },
          "presentment_money": {
            "currency_code": "EUR",
            "amount": "0.00"
          }
        },
        "estimated_taxes": false,
        "current_subtotal_price": "84.85",
        "current_subtotal_price_set": {
          "shop_money": {
            "currency_code": "EUR",
            "amount": "84.85"
          },
          "presentment_money": {
            "currency_code": "EUR",
            "amount": "84.85"
          }
        },
        "current_total_discounts": "4.95",
        "current_total_discounts_set": {
          "shop_money": {
            "currency_code": "EUR",
            "amount": "4.95"
          },
          "presentment_money": {
            "currency_code": "EUR",
            "amount": "4.95"
          }
        },
        "current_total_price": "84.85",
        "current_total_price_set": {
          "shop_money": {
            "currency_code": "EUR",
            "amount": "84.85"
          },
          "presentment_money": {
            "currency_code": "EUR",
            "amount": "84.85"
          }
        },
        "current_total_tax": "0.00",
        "current_total_tax_set": {
          "shop_money": {
            "currency_code": "EUR",
            "amount": "0.00"
          },
          "presentment_money": {
            "currency_code": "EUR",
            "amount": "0.00"
          }
        },
        "payment_terms": {},
        "current_total_additional_fees_set": {},
        "original_total_additional_fees_set": {},
        "po_number": null,
        "tax_exempt": false,
        "company": {
          "id": null,
          "location_id": null
        }
      }
    ]
  },
  "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:
amazon,
bigcommerce,
bol,
lightspeed_c,
magento,
mirakl,
shopify,
woocommerce
​
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.

​
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

​
limit
number
default:10

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

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

​
updated_at_min
string<date-time>

Show orders last updated at or after date.

Supported channels are shopify, woocommerce, bigcommerce, lightspeed_c, bol, amazon

​
updated_at_max
string<date-time>

Show orders last updated at or before date.

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

​
created_at_min
string<date-time>

Show orders created at or after date.

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

​
created_at_max
string<date-time>

Show orders created at or before date.

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

​
processed_at_min
string<date-time>

Show orders imported at or after date.

Supported channels: shopify

​
processed_at_max
string<date-time>

Show orders imported at or before date.

Supported channels: shopify

​
ids
string

Retrieve only orders specified by a comma-separated list of order IDs.

Supported channels are shopify, woocommerce, bigcommerce, amazon

​
status
enum<string> | null
default:open

Filter orders by their status.

Supported channels are shopify, woocommerce, bol, amazon

Available options:
open,
closed,
cancelled,
any
​
since_id
string<integer>

Show orders after the specified ID.

Supported channels are shopify, woocommerce, lightspeed_c

​
fields
string

Retrieve only certain fields, specified by a comma-separated list of fields names.

Supported channels are shopify,lightspeed_c

​
attribution_app_id
string

Show orders attributed to a certain app, specified by the app ID. Set as current to show orders for the app currently consuming the API.

Supported channels are shopify

​
financial_status
enum<string> | null
default:any

Filter orders by their financial status.

Supported channels are shopify

Available options:
authorized,
paid,
pending,
partially_paid,
partially_refunded,
refunded,
voided,
any,
unpaid
​
fulfillment_status
enum<string> | null
default:any

Filter orders by their fulfillment status.

Supported channels are shopify

Available options:
shipped,
partial,
unshipped,
any,
unfulfilled
​
params
object

Response

200 - application/json

POST /Unified/Orders Successful response

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