POST
/
api
/
KarizClientApp
/
Unified
/
Fulfillments
curl --request POST \
  --url https://api.trykariz.com/api/KarizClientApp/Unified/Fulfillments \
  --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"
      }
    ]
  },
  "order_id": "ORDER-4567",
  "created_at_max": "2024-03-10T10:00:00-07:00",
  "created_at_min": "2024-03-01T09:00:00-07:00",
  "fields": "id,order_id,created_at,status",
  "limit": 100,
  "since_id": 123456,
  "updated_at_max": "2024-03-11T12:00:00-07:00",
  "updated_at_min": "2024-03-05T14:00:00-07: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": {
      "fulfillments": [
        {
          "id": 255858046,
          "order_id": 450789469,
          "status": "failure",
          "created_at": "2025-01-02T11:38:15-05:00",
          "service": "manual",
          "updated_at": "2025-01-02T11:38:15-05:00",
          "tracking_company": "USPS",
          "shipment_status": null,
          "location_id": 655441491,
          "origin_address": null,
          "line_items": [
            {
              "id": 466157049,
              "variant_id": 39072856,
              "title": "IPod Nano - 8gb",
              "quantity": 1,
              "sku": "IPOD2008GREEN",
              "variant_title": "green",
              "vendor": null,
              "fulfillment_service": "manual",
              "product_id": 632910392,
              "requires_shipping": true,
              "taxable": true,
              "gift_card": false,
              "name": "IPod Nano - 8gb - green",
              "variant_inventory_management": "shopify",
              "properties": [
                {
                  "name": "Custom Engraving Front",
                  "value": "Happy Birthday"
                },
                {
                  "name": "Custom Engraving Back",
                  "value": "Merry Christmas"
                }
              ],
              "product_exists": true,
              "fulfillable_quantity": 0,
              "grams": 200,
              "price": "199.00",
              "total_discount": "0.00",
              "fulfillment_status": null,
              "price_set": {
                "shop_money": {
                  "amount": "199.00",
                  "currency_code": "USD"
                },
                "presentment_money": {
                  "amount": "199.00",
                  "currency_code": "USD"
                }
              },
              "total_discount_set": {
                "shop_money": {
                  "amount": "0.00",
                  "currency_code": "USD"
                },
                "presentment_money": {
                  "amount": "0.00",
                  "currency_code": "USD"
                }
              },
              "discount_allocations": [
                {
                  "amount": "3.34",
                  "discount_application_index": 0,
                  "amount_set": {
                    "shop_money": {
                      "amount": "3.34",
                      "currency_code": "USD"
                    },
                    "presentment_money": {
                      "amount": "3.34",
                      "currency_code": "USD"
                    }
                  }
                }
              ],
              "admin_graphql_api_id": "gid://shopify/LineItem/466157049",
              "duties": [],
              "tax_lines": [
                {
                  "price": "3.98",
                  "rate": 0.06,
                  "title": "State Tax",
                  "price_set": {
                    "shop_money": {
                      "amount": "3.98",
                      "currency_code": "USD"
                    },
                    "presentment_money": {
                      "amount": "3.98",
                      "currency_code": "USD"
                    }
                  },
                  "channel_liable": null
                }
              ],
              "fulfillment_line_item_id": 225088298
            }
          ],
          "tracking_number": "1Z1234512345123456",
          "tracking_numbers": [
            "1Z1234512345123456"
          ],
          "tracking_url": "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z1234512345123456",
          "tracking_urls": [
            "https://tools.usps.com/go/TrackConfirmAction_input?qtc_tLabels1=1Z1234512345123456"
          ],
          "receipt": {
            "testcase": true,
            "authorization": "123456"
          },
          "name": "#1001.0",
          "admin_graphql_api_id": "gid://shopify/Fulfillment/255858046"
        }
      ]
    }
  },
  "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/fulfillments.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.

​
order_id
string

The unique identifier for the order.

​
created_at_max
string<date-time>

Show fulfillments created at or before this date and time (ISO 8601 format, e.g., 2014-04-25T16:15:47-04:00).

​
created_at_min
string<date-time>

Show fulfillments created at or after this date and time (ISO 8601 format, e.g., 2014-04-25T16:15:47-04:00).

​
fields
string

A comma-separated list of fields to include in the response.

​
limit
integer
default:10

Limit the amount of results.

Required range: 1 <= x <= 250
​
since_id
integer

Restrict results to after the specified fulfillment ID (exclusive).

Required range: x >= 0
​
updated_at_max
string<date-time>

Show fulfillments last updated at or before this date and time (ISO 8601 format, e.g., 2014-04-25T16:15:47-04:00).

​
updated_at_min
string<date-time>

Show fulfillments last updated at or after this date and time (ISO 8601 format, e.g., 2014-04-25T16:15:47-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/Fulfillments Successful response

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