{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api.cartgenie.com" } ], "info": { "name": "CartGenie Public API", "_postman_id": "1e38b936-a14a-4bdf-9375-0a3d005fa560", "description": "Read and write store data from your own systems: products, variants, inventory, orders and webhooks.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Store", "description": "", "item": [ { "name": "Get store information", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/store", "query": [], "raw": "{{baseUrl}}\/public\/v1\/store" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the store the token belongs to. Useful as a connection check: a\n`200` here means the token is valid, the Public API is enabled for the\nstore, and the token's owner still has access to it.\n\nA `404` with an empty `message` has one cause here: the Public API is not\nenabled for the store. Reach for the store settings before suspecting the\ntoken. An archived store answers `404` as well, carrying\n`This store is archived.` as the `message`." }, "response": [ { "header": [], "code": 200, "body": "{\n \"name\": \"Example Store\",\n \"domain\": \"https:\/\/example.webflow.io\",\n \"currency\": \"usd\",\n \"timezone\": \"UTC\",\n \"created_at\": \"2025-11-02T08:31:00.000000Z\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\": \"\"}", "name": "Public API is not enabled for this store" }, { "header": [], "code": 404, "body": "{\"message\": \"This store is archived.\"}", "name": "Store is archived" } ] } ] }, { "name": "Products", "description": "", "item": [ { "name": "List products", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/products", "query": [ { "key": "limit", "value": "50", "description": "Results per page, 1\u2013250.", "disabled": false }, { "key": "cursor", "value": "eyJpZCI6MzY0fQ", "description": "Opaque cursor from `meta.next_cursor` of the previous page.", "disabled": false }, { "key": "search", "value": "tee", "description": "Matches against product name and slug.", "disabled": false }, { "key": "updated_since", "value": "2026-08-01T00:00:00Z", "description": "ISO-8601 timestamp. Returns products changed or deleted since then.", "disabled": false } ], "raw": "{{baseUrl}}\/public\/v1\/products?limit=50&cursor=eyJpZCI6MzY0fQ&search=tee&updated_since=2026-08-01T00%3A00%3A00Z" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the store's products, oldest update first. Pass `updated_since` to\nreceive an incremental feed: the result then also carries the products the\nstore has removed, so a mirrored catalog can drop them.\n\n`deleted_at` is the removal signal \u2014 drop any record that carries one,\nwhatever its `status`. Removal reaches the feed in two shapes. A product\narchived in the admin keeps the full product shape and its own status. A\nproduct removed permanently collapses to `\"status\": \"deleted\"` and carries\nonly `id`, `name`, `slug`, `status`, `deleted_at` and `updated_at` \u2014 no\n`price`, `stock`, `variants`, `images`, `url` or `created_at`. Read\n`deleted_at` and `status` before any other field.\n\nArchiving is a removal here by design: it unpublishes the product, so a\nshopper cannot buy it and it belongs out of any catalog you mirror from\nthis feed. Restoring the product in the admin returns it to a later page\nwith `deleted_at` back to `null`, carrying whatever status the restoring\naction set: un-archiving returns it as `draft`, publishing straight out of\nthe archive returns it as `published`. It is buyable again only once it is\npublished.\n\nReconcile against a full listing on a schedule: a permanent removal is not\nguaranteed to reach the feed." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 364,\n \"name\": \"Classic Tee\",\n \"slug\": \"classic-tee\",\n \"status\": \"published\",\n \"published\": true,\n \"price\": 4900,\n \"formatted_price\": \"$49.00\",\n \"stock\": 120,\n \"available_stock\": 118,\n \"track_inventory\": true,\n \"images\": {\n \"main_image\": \"https:\/\/cdn.example.com\/tee.jpg\",\n \"main_image_large\": \"https:\/\/cdn.example.com\/tee-large.jpg\"\n },\n \"url\": \"https:\/\/store.example.com\/product\/classic-tee\",\n \"variants\": [\n {\n \"id\": 2301,\n \"product_id\": 364,\n \"sku\": \"TEE-BLK-M\",\n \"title\": \"black-medium\",\n \"published\": true,\n \"price\": 4900,\n \"formatted_price\": \"$49.00\",\n \"stock\": 120,\n \"reserved_stock\": 2,\n \"available_stock\": 118,\n \"track_inventory\": true,\n \"requires_shipping\": true,\n \"dimensions\": {\"height\": 2, \"length\": 30, \"width\": 20, \"weight\": 180},\n \"created_at\": \"2026-01-14T09:00:00.000000Z\",\n \"updated_at\": \"2026-08-01T11:20:31.000000Z\"\n }\n ],\n \"created_at\": \"2026-01-14T09:00:00.000000Z\",\n \"deleted_at\": null,\n \"updated_at\": \"2026-08-01T11:20:31.000000Z\"\n }\n ],\n \"meta\": {\n \"per_page\": 50,\n \"has_more\": true,\n \"next_cursor\": \"eyJpZCI6MzY0fQ\"\n }\n}", "name": "Catalog page" }, { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 351,\n \"name\": \"Summer Cap\",\n \"slug\": \"summer-cap\",\n \"status\": \"deleted\",\n \"deleted_at\": \"2026-08-03T14:22:09.000000Z\",\n \"updated_at\": \"2026-08-03T14:22:09.000000Z\"\n },\n {\n \"id\": 358,\n \"name\": \"Winter Scarf\",\n \"slug\": \"winter-scarf\",\n \"status\": \"archived\",\n \"published\": false,\n \"price\": 2900,\n \"formatted_price\": \"$29.00\",\n \"stock\": 0,\n \"available_stock\": 0,\n \"track_inventory\": true,\n \"images\": {\n \"main_image\": \"https:\/\/cdn.example.com\/scarf.jpg\",\n \"main_image_large\": \"https:\/\/cdn.example.com\/scarf-large.jpg\"\n },\n \"url\": \"https:\/\/store.example.com\/product\/winter-scarf\",\n \"variants\": [\n {\n \"id\": 2288,\n \"product_id\": 358,\n \"sku\": \"SCARF-GRY\",\n \"title\": \"grey\",\n \"published\": false,\n \"price\": 2900,\n \"formatted_price\": \"$29.00\",\n \"stock\": 0,\n \"reserved_stock\": 0,\n \"available_stock\": 0,\n \"track_inventory\": true,\n \"requires_shipping\": true,\n \"dimensions\": {\"height\": 1, \"length\": 25, \"width\": 15, \"weight\": 90},\n \"created_at\": \"2026-02-02T08:12:00.000000Z\",\n \"updated_at\": \"2026-08-04T09:15:44.000000Z\"\n }\n ],\n \"created_at\": \"2026-02-02T08:12:00.000000Z\",\n \"deleted_at\": \"2026-08-04T09:15:44.000000Z\",\n \"updated_at\": \"2026-08-04T09:15:44.000000Z\"\n }\n ],\n \"meta\": {\n \"per_page\": 50,\n \"has_more\": false,\n \"next_cursor\": null\n }\n}", "name": "Incremental feed carrying both removal shapes" }, { "header": [], "code": 422, "body": "{\"message\": \"The cursor is invalid.\", \"errors\": {\"cursor\": [\"The cursor is invalid.\"]}}", "name": "Malformed cursor" } ] }, { "name": "Get a product", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/products\/:id", "query": [], "raw": "{{baseUrl}}\/public\/v1\/products\/:id", "variable": [ { "id": "id", "key": "id", "value": 364, "description": "The product id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Includes the product's variants." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 364,\n \"name\": \"Classic Tee\",\n \"slug\": \"classic-tee\",\n \"status\": \"published\",\n \"published\": true,\n \"price\": 4900,\n \"formatted_price\": \"$49.00\",\n \"stock\": 120,\n \"available_stock\": 118,\n \"track_inventory\": true,\n \"images\": {\n \"main_image\": \"https:\/\/cdn.example.com\/tee.jpg\",\n \"main_image_large\": \"https:\/\/cdn.example.com\/tee-large.jpg\"\n },\n \"url\": \"https:\/\/store.example.com\/product\/classic-tee\",\n \"variants\": [\n {\n \"id\": 2301,\n \"product_id\": 364,\n \"sku\": \"TEE-BLK-M\",\n \"title\": \"black-medium\",\n \"published\": true,\n \"price\": 4900,\n \"formatted_price\": \"$49.00\",\n \"stock\": 120,\n \"reserved_stock\": 2,\n \"available_stock\": 118,\n \"track_inventory\": true,\n \"requires_shipping\": true,\n \"dimensions\": {\"height\": 2, \"length\": 30, \"width\": 20, \"weight\": 180},\n \"created_at\": \"2026-01-14T09:00:00.000000Z\",\n \"updated_at\": \"2026-08-01T11:20:31.000000Z\"\n }\n ],\n \"created_at\": \"2026-01-14T09:00:00.000000Z\",\n \"deleted_at\": null,\n \"updated_at\": \"2026-08-01T11:20:31.000000Z\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\": \"Resource not found.\"}", "name": "Product belongs to another store or does not exist" } ] } ] }, { "name": "Variants", "description": "", "item": [ { "name": "List variants", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/variants", "query": [ { "key": "limit", "value": "50", "description": "Results per page, 1\u2013250.", "disabled": false }, { "key": "cursor", "value": "eyJpZCI6MjMwMX0", "description": "Opaque cursor from `meta.next_cursor` of the previous page.", "disabled": false }, { "key": "sku", "value": "TEE-BLK-M", "description": "Returns every variant carrying this SKU.", "disabled": false }, { "key": "updated_since", "value": "2026-08-01T00:00:00Z", "description": "ISO-8601 timestamp.", "disabled": false } ], "raw": "{{baseUrl}}\/public\/v1\/variants?limit=50&cursor=eyJpZCI6MjMwMX0&sku=TEE-BLK-M&updated_since=2026-08-01T00%3A00%3A00Z" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns every variant in the store, oldest update first. Filter by `sku` to\nresolve your own identifiers into variant ids. SKUs are not unique within a\nstore, so this always returns an array \u2014 match on the fields you need rather\nthan assuming a single result.\n\n`stock` is the persisted level, `reserved_stock` is held by checkouts in\nflight, and `available_stock` is what a shopper can still buy.\n\nA bundle variant holds no stock of its own: `stock` carries a placeholder\nand `available_stock` is derived from its components, so read that one." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 2301,\n \"product_id\": 364,\n \"sku\": \"TEE-BLK-M\",\n \"title\": \"black-medium\",\n \"published\": true,\n \"price\": 4900,\n \"formatted_price\": \"$49.00\",\n \"stock\": 120,\n \"reserved_stock\": 2,\n \"available_stock\": 118,\n \"track_inventory\": true,\n \"requires_shipping\": true,\n \"dimensions\": {\"height\": 2, \"length\": 30, \"width\": 20, \"weight\": 180},\n \"created_at\": \"2026-01-14T09:00:00.000000Z\",\n \"updated_at\": \"2026-08-01T11:20:31.000000Z\"\n }\n ],\n \"meta\": {\"per_page\": 50, \"has_more\": false, \"next_cursor\": null}\n}", "name": "" } ] } ] }, { "name": "Inventory", "description": "", "item": [ { "name": "Set variant inventory", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/variants\/:id\/inventory", "query": [], "raw": "{{baseUrl}}\/public\/v1\/variants\/:id\/inventory", "variable": [ { "id": "id", "key": "id", "value": 2301, "description": "The variant id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"stock\":120,\"expected_stock\":118}" }, "description": "Sets the stock level to an absolute value \u2014 this is not an increment. The\nvariant must have inventory tracking enabled and must be published.\n\nSend `expected_stock` to make the write conditional: the update is applied\nonly while the stored level still matches, and a mismatch answers `409`\nwithout changing anything. The conflict response carries `actual_stock`, so\na retry needs no extra read.\n\nThe comparison is against the persisted stock level, not the available one,\nso checkouts holding reserved stock will not cause spurious conflicts." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 2301,\n \"product_id\": 364,\n \"sku\": \"TEE-BLK-M\",\n \"title\": \"black-medium\",\n \"published\": true,\n \"price\": 4900,\n \"formatted_price\": \"$49.00\",\n \"stock\": 120,\n \"reserved_stock\": 2,\n \"available_stock\": 118,\n \"track_inventory\": true,\n \"requires_shipping\": true,\n \"dimensions\": {\"height\": 2, \"length\": 30, \"width\": 20, \"weight\": 180},\n \"created_at\": \"2026-01-14T09:00:00.000000Z\",\n \"updated_at\": \"2026-08-14T10:05:12.000000Z\"\n}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\": \"Inventory changed before the update could be applied.\", \"expected_stock\": 118, \"actual_stock\": 120}", "name": "expected_stock no longer matches" }, { "header": [], "code": 409, "body": "{\"message\": \"Variant must be published before inventory can be updated.\"}", "name": "Variant is not published" }, { "header": [], "code": 422, "body": "{\"message\": \"Inventory tracking is not enabled for this variant.\"}", "name": "Inventory tracking is off for this variant" } ] } ] }, { "name": "Orders", "description": "", "item": [ { "name": "List orders", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/orders", "query": [ { "key": "limit", "value": "50", "description": "Results per page, 1\u2013250.", "disabled": false }, { "key": "cursor", "value": "eyJpZCI6MTAwMn0", "description": "Opaque cursor from `meta.next_cursor` of the previous page.", "disabled": false }, { "key": "updated_since", "value": "2026-08-01T00:00:00Z", "description": "ISO-8601 timestamp.", "disabled": false } ], "raw": "{{baseUrl}}\/public\/v1\/orders?limit=50&cursor=eyJpZCI6MTAwMn0&updated_since=2026-08-01T00%3A00%3A00Z" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the store's orders, oldest update first. Pass `updated_since` for an\nincremental feed. Orders are never removed, so a cancelled order appears as\na status change rather than a deletion." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"order_id\": \"1002\",\n \"name\": \"1002\",\n \"guid\": \"01KSNP2NFV6DJWW6MXME27Q0KE\",\n \"status\": \"unfulfilled\",\n \"currency_code\": \"usd\",\n \"coupon_code\": null,\n \"customer_email\": \"john@user.com\",\n \"customer_name\": \"John Doe\",\n \"shipment\": {\n \"tracking_url\": null,\n \"tracking_number\": null,\n \"provider\": null,\n \"address\": {\n \"name\": \"John Doe\",\n \"email\": \"john@user.com\",\n \"phone\": \"+14155550123\",\n \"country\": \"us\",\n \"state\": \"California\",\n \"region\": \"us-ca\",\n \"region_name\": \"California\",\n \"city\": \"San Francisco\",\n \"address_line_one\": \"1 Market St\",\n \"address_line_two\": null,\n \"postal_code\": \"94105\",\n \"validation_result\": null\n }\n },\n \"fulfillments\": [],\n \"billing\": {\n \"name\": \"John Doe\",\n \"email\": \"john@user.com\",\n \"phone\": \"+14155550123\",\n \"country\": \"us\",\n \"state\": \"California\",\n \"region\": \"us-ca\",\n \"region_name\": \"California\",\n \"city\": \"San Francisco\",\n \"address_line_one\": \"1 Market St\",\n \"address_line_two\": null,\n \"postal_code\": \"94105\",\n \"validation_result\": null\n },\n \"payment\": {\n \"label\": \"Visa ending in 4242\",\n \"status\": \"paid\",\n \"method\": \"credit_card\",\n \"transaction_id\": \"pi_3Q1example\"\n },\n \"details\": {\n \"custom_fields\": {\n \"Gift Message\": \"Happy birthday\"\n },\n \"checkout_type\": \"\"\n },\n \"items\": [\n {\n \"sku\": \"TEE-BLK-M\",\n \"quantity\": 1,\n \"price\": 4900,\n \"name\": \"Classic Tee\",\n \"slug\": \"classic-tee\",\n \"url\": \"https:\/\/store.example.com\/product\/classic-tee\",\n \"image_url\": \"https:\/\/cdn.example.com\/tee.jpg\",\n \"subtotal\": 4900,\n \"options\": [\n {\n \"name\": \"Size\",\n \"slug\": \"size\",\n \"value\": \"M\",\n \"value_slug\": \"m\"\n }\n ],\n \"weight\": 180,\n \"weight_unit\": \"g\",\n \"height\": 2,\n \"width\": 20,\n \"length\": 30,\n \"downloads\": [],\n \"has_subscription\": false,\n \"availability\": \"available\",\n \"estimated_shipping_date\": null,\n \"bundle_components\": [],\n \"fulfilled_quantity\": 0,\n \"remaining_fulfillment_quantity\": 1,\n \"fulfillment_state\": \"unfulfilled\"\n }\n ],\n \"subtotal\": 4900,\n \"formatted_subtotal\": \"$49.00\",\n \"total\": 5391,\n \"formatted_total\": \"$53.91\",\n \"discount_total\": 0,\n \"formatted_discount_total\": \"$0.00\",\n \"shipping_total\": 0,\n \"formatted_shipping_total\": \"$0.00\",\n \"shipping_method_label\": \"Standard\",\n \"tax_total\": 491,\n \"formatted_tax_total\": \"$4.91\",\n \"created_at\": \"2026-08-01T10:12:00.000000Z\",\n \"updated_at\": \"2026-08-01T10:12:00.000000Z\",\n \"placed_at\": \"2026-08-01T10:12:00.000000Z\",\n \"fulfilled_at\": null,\n \"disputed_at\": null,\n \"discounts\": []\n }\n ],\n \"meta\": {\n \"per_page\": 50,\n \"has_more\": true,\n \"next_cursor\": \"eyJpZCI6MTAwMn0\"\n }\n}\n", "name": "" } ] }, { "name": "Get an order", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/orders\/:orderName", "query": [], "raw": "{{baseUrl}}\/public\/v1\/orders\/:orderName", "variable": [ { "id": "orderName", "key": "orderName", "value": "1002", "description": "The order name." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Orders are addressed by the name the merchant sees, not by a database id.\n\nA `refunds` array is present only when `payment.status` is `refunded` or\n`partially_refunded`; each entry carries `id`, `amount`, `formatted_amount`,\n`quantity`, `status`, `reason` and `created_at`. Treat its absence as\n\"nothing refunded\" rather than as an error.\n\nSome fields are only as complete as the order is. `shipment` is an object\nwhen the order has at least one shippable item and an empty array `[]` when\nit has none, as on a digital-only order.\n\nUnder `payment`, `status` always carries a value and reads `unpaid` before\nthe charge is captured, while `method` and `transaction_id` are `null` until\nthe gateway records them. `billing` and `payment.label` are `null` together,\nand only on an order whose billing record was never written." }, "response": [ { "header": [], "code": 200, "body": "{\n \"order_id\": \"1002\",\n \"name\": \"1002\",\n \"guid\": \"01KSNP2NFV6DJWW6MXME27Q0KE\",\n \"status\": \"unfulfilled\",\n \"currency_code\": \"usd\",\n \"coupon_code\": null,\n \"customer_email\": \"john@user.com\",\n \"customer_name\": \"John Doe\",\n \"shipment\": {\n \"tracking_url\": null,\n \"tracking_number\": null,\n \"provider\": null,\n \"address\": {\n \"name\": \"John Doe\",\n \"email\": \"john@user.com\",\n \"phone\": \"+14155550123\",\n \"country\": \"us\",\n \"state\": \"California\",\n \"region\": \"us-ca\",\n \"region_name\": \"California\",\n \"city\": \"San Francisco\",\n \"address_line_one\": \"1 Market St\",\n \"address_line_two\": null,\n \"postal_code\": \"94105\",\n \"validation_result\": null\n }\n },\n \"fulfillments\": [],\n \"billing\": {\n \"name\": \"John Doe\",\n \"email\": \"john@user.com\",\n \"phone\": \"+14155550123\",\n \"country\": \"us\",\n \"state\": \"California\",\n \"region\": \"us-ca\",\n \"region_name\": \"California\",\n \"city\": \"San Francisco\",\n \"address_line_one\": \"1 Market St\",\n \"address_line_two\": null,\n \"postal_code\": \"94105\",\n \"validation_result\": null\n },\n \"payment\": {\n \"label\": \"Visa ending in 4242\",\n \"status\": \"paid\",\n \"method\": \"credit_card\",\n \"transaction_id\": \"pi_3Q1example\"\n },\n \"details\": {\n \"custom_fields\": {\n \"Gift Message\": \"Happy birthday\"\n },\n \"checkout_type\": \"\"\n },\n \"items\": [\n {\n \"sku\": \"TEE-BLK-M\",\n \"quantity\": 1,\n \"price\": 4900,\n \"name\": \"Classic Tee\",\n \"slug\": \"classic-tee\",\n \"url\": \"https:\/\/store.example.com\/product\/classic-tee\",\n \"image_url\": \"https:\/\/cdn.example.com\/tee.jpg\",\n \"subtotal\": 4900,\n \"options\": [\n {\n \"name\": \"Size\",\n \"slug\": \"size\",\n \"value\": \"M\",\n \"value_slug\": \"m\"\n }\n ],\n \"weight\": 180,\n \"weight_unit\": \"g\",\n \"height\": 2,\n \"width\": 20,\n \"length\": 30,\n \"downloads\": [],\n \"has_subscription\": false,\n \"availability\": \"available\",\n \"estimated_shipping_date\": null,\n \"bundle_components\": [],\n \"fulfilled_quantity\": 0,\n \"remaining_fulfillment_quantity\": 1,\n \"fulfillment_state\": \"unfulfilled\"\n }\n ],\n \"subtotal\": 4900,\n \"formatted_subtotal\": \"$49.00\",\n \"total\": 5391,\n \"formatted_total\": \"$53.91\",\n \"discount_total\": 0,\n \"formatted_discount_total\": \"$0.00\",\n \"shipping_total\": 0,\n \"formatted_shipping_total\": \"$0.00\",\n \"shipping_method_label\": \"Standard\",\n \"tax_total\": 491,\n \"formatted_tax_total\": \"$4.91\",\n \"created_at\": \"2026-08-01T10:12:00.000000Z\",\n \"updated_at\": \"2026-08-01T10:12:00.000000Z\",\n \"placed_at\": \"2026-08-01T10:12:00.000000Z\",\n \"fulfilled_at\": null,\n \"disputed_at\": null,\n \"discounts\": []\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\"message\": \"Resource not found.\"}", "name": "Unknown order" } ] }, { "name": "Update tracking", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/orders\/:orderName\/tracking", "query": [], "raw": "{{baseUrl}}\/public\/v1\/orders\/:orderName\/tracking", "variable": [ { "id": "orderName", "key": "orderName", "value": "1002", "description": "The order name." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"shipping_carrier\":\"DHL\",\"tracking_number\":\"JD014600006281230542\",\"tracking_url\":\"https:\\\/\\\/www.dhl.com\\\/track?id=JD014600006281230542\",\"fulfillment_id\":91}" }, "description": "Adds or replaces the shipping carrier and tracking details on an order. Send\na field as `null` to clear it. The order must contain at least one shippable\nitem, and at least one of `shipping_carrier`, `tracking_number` or\n`tracking_url` must be present.\n\nWhere the details land depends on how many fulfillments the order has. With\nmore than one, or when the order is partially fulfilled, `fulfillment_id` is\nrequired and targets that fulfillment. With exactly one, omit it and the\ndetails go to that fulfillment. With none, they go to the order's shipment.\n\nRead the tracking back from where it was written: anything stored on a\nfulfillment comes back under the matching entry in `fulfillments[]`, and\n`shipment.tracking_url`, `shipment.tracking_number` and `shipment.provider`\nare always `null` once the order has any fulfillment." }, "response": [ { "header": [], "code": 200, "body": "{\"order_id\":\"1002\",\"name\":\"1002\",\"guid\":\"01KSNP2NFV6DJWW6MXME27Q0KE\",\"status\":\"unfulfilled\",\"currency_code\":\"usd\",\"coupon_code\":null,\"customer_email\":\"john@user.com\",\"customer_name\":\"John Doe\",\"shipment\":{\"provider\":\"DHL\",\"tracking_number\":\"JD014600006281230542\",\"tracking_url\":\"https:\\\/\\\/www.dhl.com\\\/track?id=JD014600006281230542\",\"address\":{\"name\":\"John Doe\",\"email\":\"john@user.com\",\"phone\":\"+14155550123\",\"country\":\"us\",\"state\":\"California\",\"region\":\"us-ca\",\"region_name\":\"California\",\"city\":\"San Francisco\",\"address_line_one\":\"1 Market St\",\"address_line_two\":null,\"postal_code\":\"94105\",\"validation_result\":null}},\"fulfillments\":[],\"billing\":{\"name\":\"John Doe\",\"email\":\"john@user.com\",\"phone\":\"+14155550123\",\"country\":\"us\",\"state\":\"California\",\"region\":\"us-ca\",\"region_name\":\"California\",\"city\":\"San Francisco\",\"address_line_one\":\"1 Market St\",\"address_line_two\":null,\"postal_code\":\"94105\",\"validation_result\":null},\"payment\":{\"label\":\"Visa ending in 4242\",\"status\":\"paid\",\"method\":\"credit_card\",\"transaction_id\":\"pi_3Q1example\"},\"details\":{\"custom_fields\":{\"Gift Message\":\"Happy birthday\"},\"checkout_type\":\"\"},\"items\":[{\"sku\":\"TEE-BLK-M\",\"quantity\":1,\"price\":4900,\"name\":\"Classic Tee\",\"slug\":\"classic-tee\",\"url\":\"https:\\\/\\\/store.example.com\\\/product\\\/classic-tee\",\"image_url\":\"https:\\\/\\\/cdn.example.com\\\/tee.jpg\",\"subtotal\":4900,\"options\":[{\"name\":\"Size\",\"slug\":\"size\",\"value\":\"M\",\"value_slug\":\"m\"}],\"weight\":180,\"weight_unit\":\"g\",\"height\":2,\"width\":20,\"length\":30,\"downloads\":[],\"has_subscription\":false,\"availability\":\"available\",\"estimated_shipping_date\":null,\"bundle_components\":[],\"fulfilled_quantity\":0,\"remaining_fulfillment_quantity\":1,\"fulfillment_state\":\"unfulfilled\"}],\"subtotal\":4900,\"formatted_subtotal\":\"$49.00\",\"total\":5391,\"formatted_total\":\"$53.91\",\"discount_total\":0,\"formatted_discount_total\":\"$0.00\",\"shipping_total\":0,\"formatted_shipping_total\":\"$0.00\",\"shipping_method_label\":\"Standard\",\"tax_total\":491,\"formatted_tax_total\":\"$4.91\",\"created_at\":\"2026-08-01T10:12:00.000000Z\",\"updated_at\":\"2026-08-14T10:05:12.000000Z\",\"placed_at\":\"2026-08-01T10:12:00.000000Z\",\"fulfilled_at\":null,\"disputed_at\":null,\"discounts\":[]}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"Order has no shippable items.\"}", "name": "Nothing to ship" }, { "header": [], "code": 422, "body": "{\"message\": \"At least one supported field is required.\", \"errors\": {\"request\": [\"At least one supported field is required.\"]}}", "name": "No tracking field sent" }, { "header": [], "code": 422, "body": "{\"message\": \"The fulfillment id field is required.\", \"errors\": {\"fulfillment_id\": [\"The fulfillment id field is required.\"]}}", "name": "fulfillment_id omitted on a multi-fulfillment order" }, { "header": [], "code": 422, "body": "{\"message\": \"The fulfillment_id does not belong to this order.\", \"errors\": {\"fulfillment_id\": [\"The fulfillment_id does not belong to this order.\"]}}", "name": "Fulfillment belongs to another order" } ] }, { "name": "Fulfill an order", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/orders\/:orderName\/fulfill", "query": [], "raw": "{{baseUrl}}\/public\/v1\/orders\/:orderName\/fulfill", "variable": [ { "id": "orderName", "key": "orderName", "value": "1002", "description": "The order name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"shipping_carrier\":\"DHL\",\"tracking_number\":\"JD014600006281230542\",\"tracking_url\":\"https:\\\/\\\/www.dhl.com\\\/track?id=JD014600006281230542\",\"send_notification\":true}" }, "description": "Marks the whole order fulfilled and, when `send_notification` is true, emails\nthe customer. Tracking details sent here are stored alongside the fulfillment,\nso a shipment can be recorded in one call.\n\nOnly whole-order fulfillment is supported; item-level fulfillment is not part\nof this version.\n\nEach `fulfillments[].items[].order_item_id` is an internal identifier for the\nline it covers; it is not repeated in `items[]`, which carries no id. A line\ncovering a bundle carries a fourth key, `components[]`, whose entries hold\n`live_product_variant_id`, `name` and `quantity` for each bundled variant." }, "response": [ { "header": [], "code": 200, "body": "{\n \"order_id\": \"1002\",\n \"name\": \"1002\",\n \"guid\": \"01KSNP2NFV6DJWW6MXME27Q0KE\",\n \"status\": \"fulfilled\",\n \"currency_code\": \"usd\",\n \"coupon_code\": null,\n \"customer_email\": \"john@user.com\",\n \"customer_name\": \"John Doe\",\n \"shipment\": {\n \"tracking_url\": null,\n \"tracking_number\": null,\n \"provider\": null,\n \"address\": {\n \"name\": \"John Doe\",\n \"email\": \"john@user.com\",\n \"phone\": \"+14155550123\",\n \"country\": \"us\",\n \"state\": \"California\",\n \"region\": \"us-ca\",\n \"region_name\": \"California\",\n \"city\": \"San Francisco\",\n \"address_line_one\": \"1 Market St\",\n \"address_line_two\": null,\n \"postal_code\": \"94105\",\n \"validation_result\": null\n }\n },\n \"fulfillments\": [\n {\n \"id\": 91,\n \"provider\": \"DHL\",\n \"tracking_number\": \"JD014600006281230542\",\n \"tracking_url\": \"https:\/\/www.dhl.com\/track?id=JD014600006281230542\",\n \"fulfilled_at\": \"2026-08-14T10:05:12.000000Z\",\n \"items\": [\n {\n \"order_item_id\": 5501,\n \"name\": \"Classic Tee\",\n \"quantity\": 1\n }\n ]\n }\n ],\n \"billing\": {\n \"name\": \"John Doe\",\n \"email\": \"john@user.com\",\n \"phone\": \"+14155550123\",\n \"country\": \"us\",\n \"state\": \"California\",\n \"region\": \"us-ca\",\n \"region_name\": \"California\",\n \"city\": \"San Francisco\",\n \"address_line_one\": \"1 Market St\",\n \"address_line_two\": null,\n \"postal_code\": \"94105\",\n \"validation_result\": null\n },\n \"payment\": {\n \"label\": \"Visa ending in 4242\",\n \"status\": \"paid\",\n \"method\": \"credit_card\",\n \"transaction_id\": \"pi_3Q1example\"\n },\n \"details\": {\n \"custom_fields\": {\n \"Gift Message\": \"Happy birthday\"\n },\n \"checkout_type\": \"\"\n },\n \"items\": [\n {\n \"sku\": \"TEE-BLK-M\",\n \"quantity\": 1,\n \"price\": 4900,\n \"name\": \"Classic Tee\",\n \"slug\": \"classic-tee\",\n \"url\": \"https:\/\/store.example.com\/product\/classic-tee\",\n \"image_url\": \"https:\/\/cdn.example.com\/tee.jpg\",\n \"subtotal\": 4900,\n \"options\": [\n {\n \"name\": \"Size\",\n \"slug\": \"size\",\n \"value\": \"M\",\n \"value_slug\": \"m\"\n }\n ],\n \"weight\": 180,\n \"weight_unit\": \"g\",\n \"height\": 2,\n \"width\": 20,\n \"length\": 30,\n \"downloads\": [],\n \"has_subscription\": false,\n \"availability\": \"available\",\n \"estimated_shipping_date\": null,\n \"bundle_components\": [],\n \"fulfilled_quantity\": 1,\n \"remaining_fulfillment_quantity\": 0,\n \"fulfillment_state\": \"fulfilled\"\n }\n ],\n \"subtotal\": 4900,\n \"formatted_subtotal\": \"$49.00\",\n \"total\": 5391,\n \"formatted_total\": \"$53.91\",\n \"discount_total\": 0,\n \"formatted_discount_total\": \"$0.00\",\n \"shipping_total\": 0,\n \"formatted_shipping_total\": \"$0.00\",\n \"shipping_method_label\": \"Standard\",\n \"tax_total\": 491,\n \"formatted_tax_total\": \"$4.91\",\n \"created_at\": \"2026-08-01T10:12:00.000000Z\",\n \"updated_at\": \"2026-08-14T10:05:12.000000Z\",\n \"placed_at\": \"2026-08-01T10:12:00.000000Z\",\n \"fulfilled_at\": \"2026-08-14T10:05:12.000000Z\",\n \"disputed_at\": null,\n \"discounts\": []\n}\n", "name": "" }, { "header": [], "code": 409, "body": "{\"message\": \"Order cannot be fulfilled from status canceled.\"}", "name": "Order is in a status that cannot be fulfilled" } ] }, { "name": "Unfulfill an order", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/orders\/:orderName\/unfulfill", "query": [], "raw": "{{baseUrl}}\/public\/v1\/orders\/:orderName\/unfulfill", "variable": [ { "id": "orderName", "key": "orderName", "value": "1002", "description": "The order name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a fulfilled or partially fulfilled order to the unfulfilled state.\nTracking stored on the order's shipment is kept; tracking recorded on a\nfulfillment is removed with the fulfillment." }, "response": [ { "header": [], "code": 200, "body": "{\"order_id\":\"1002\",\"name\":\"1002\",\"guid\":\"01KSNP2NFV6DJWW6MXME27Q0KE\",\"status\":\"unfulfilled\",\"currency_code\":\"usd\",\"coupon_code\":null,\"customer_email\":\"john@user.com\",\"customer_name\":\"John Doe\",\"shipment\":{\"provider\":\"DHL\",\"tracking_number\":\"JD014600006281230542\",\"tracking_url\":\"https:\\\/\\\/www.dhl.com\\\/track?id=JD014600006281230542\",\"address\":{\"name\":\"John Doe\",\"email\":\"john@user.com\",\"phone\":\"+14155550123\",\"country\":\"us\",\"state\":\"California\",\"region\":\"us-ca\",\"region_name\":\"California\",\"city\":\"San Francisco\",\"address_line_one\":\"1 Market St\",\"address_line_two\":null,\"postal_code\":\"94105\",\"validation_result\":null}},\"fulfillments\":[],\"billing\":{\"name\":\"John Doe\",\"email\":\"john@user.com\",\"phone\":\"+14155550123\",\"country\":\"us\",\"state\":\"California\",\"region\":\"us-ca\",\"region_name\":\"California\",\"city\":\"San Francisco\",\"address_line_one\":\"1 Market St\",\"address_line_two\":null,\"postal_code\":\"94105\",\"validation_result\":null},\"payment\":{\"label\":\"Visa ending in 4242\",\"status\":\"paid\",\"method\":\"credit_card\",\"transaction_id\":\"pi_3Q1example\"},\"details\":{\"custom_fields\":{\"Gift Message\":\"Happy birthday\"},\"checkout_type\":\"\"},\"items\":[{\"sku\":\"TEE-BLK-M\",\"quantity\":1,\"price\":4900,\"name\":\"Classic Tee\",\"slug\":\"classic-tee\",\"url\":\"https:\\\/\\\/store.example.com\\\/product\\\/classic-tee\",\"image_url\":\"https:\\\/\\\/cdn.example.com\\\/tee.jpg\",\"subtotal\":4900,\"options\":[{\"name\":\"Size\",\"slug\":\"size\",\"value\":\"M\",\"value_slug\":\"m\"}],\"weight\":180,\"weight_unit\":\"g\",\"height\":2,\"width\":20,\"length\":30,\"downloads\":[],\"has_subscription\":false,\"availability\":\"available\",\"estimated_shipping_date\":null,\"bundle_components\":[],\"fulfilled_quantity\":0,\"remaining_fulfillment_quantity\":1,\"fulfillment_state\":\"unfulfilled\"}],\"subtotal\":4900,\"formatted_subtotal\":\"$49.00\",\"total\":5391,\"formatted_total\":\"$53.91\",\"discount_total\":0,\"formatted_discount_total\":\"$0.00\",\"shipping_total\":0,\"formatted_shipping_total\":\"$0.00\",\"shipping_method_label\":\"Standard\",\"tax_total\":491,\"formatted_tax_total\":\"$4.91\",\"created_at\":\"2026-08-01T10:12:00.000000Z\",\"updated_at\":\"2026-08-14T10:41:03.000000Z\",\"placed_at\":\"2026-08-01T10:12:00.000000Z\",\"fulfilled_at\":null,\"disputed_at\":null,\"discounts\":[]}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\": \"Order cannot be unfulfilled from status unfulfilled.\"}", "name": "Order was never fulfilled" } ] }, { "name": "Cancel an order", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/orders\/:orderName\/cancel", "query": [], "raw": "{{baseUrl}}\/public\/v1\/orders\/:orderName\/cancel", "variable": [ { "id": "orderName", "key": "orderName", "value": "1002", "description": "The order name." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Moves the order to the canceled status and sends the usual cancellation\nevent and email.\n\nThis is a status change only. It does **not** refund the payment, return\nstock to inventory, remove fulfillments, or cancel subscriptions created by\nthe order \u2014 handle those separately if your flow needs them." }, "response": [ { "header": [], "code": 200, "body": "{\"order_id\":\"1002\",\"name\":\"1002\",\"guid\":\"01KSNP2NFV6DJWW6MXME27Q0KE\",\"status\":\"canceled\",\"currency_code\":\"usd\",\"coupon_code\":null,\"customer_email\":\"john@user.com\",\"customer_name\":\"John Doe\",\"shipment\":{\"tracking_url\":null,\"tracking_number\":null,\"provider\":null,\"address\":{\"name\":\"John Doe\",\"email\":\"john@user.com\",\"phone\":\"+14155550123\",\"country\":\"us\",\"state\":\"California\",\"region\":\"us-ca\",\"region_name\":\"California\",\"city\":\"San Francisco\",\"address_line_one\":\"1 Market St\",\"address_line_two\":null,\"postal_code\":\"94105\",\"validation_result\":null}},\"fulfillments\":[],\"billing\":{\"name\":\"John Doe\",\"email\":\"john@user.com\",\"phone\":\"+14155550123\",\"country\":\"us\",\"state\":\"California\",\"region\":\"us-ca\",\"region_name\":\"California\",\"city\":\"San Francisco\",\"address_line_one\":\"1 Market St\",\"address_line_two\":null,\"postal_code\":\"94105\",\"validation_result\":null},\"payment\":{\"label\":\"Visa ending in 4242\",\"status\":\"paid\",\"method\":\"credit_card\",\"transaction_id\":\"pi_3Q1example\"},\"details\":{\"custom_fields\":{\"Gift Message\":\"Happy birthday\"},\"checkout_type\":\"\"},\"items\":[{\"sku\":\"TEE-BLK-M\",\"quantity\":1,\"price\":4900,\"name\":\"Classic Tee\",\"slug\":\"classic-tee\",\"url\":\"https:\\\/\\\/store.example.com\\\/product\\\/classic-tee\",\"image_url\":\"https:\\\/\\\/cdn.example.com\\\/tee.jpg\",\"subtotal\":4900,\"options\":[{\"name\":\"Size\",\"slug\":\"size\",\"value\":\"M\",\"value_slug\":\"m\"}],\"weight\":180,\"weight_unit\":\"g\",\"height\":2,\"width\":20,\"length\":30,\"downloads\":[],\"has_subscription\":false,\"availability\":\"available\",\"estimated_shipping_date\":null,\"bundle_components\":[],\"fulfilled_quantity\":0,\"remaining_fulfillment_quantity\":1,\"fulfillment_state\":\"unfulfilled\"}],\"subtotal\":4900,\"formatted_subtotal\":\"$49.00\",\"total\":5391,\"formatted_total\":\"$53.91\",\"discount_total\":0,\"formatted_discount_total\":\"$0.00\",\"shipping_total\":0,\"formatted_shipping_total\":\"$0.00\",\"shipping_method_label\":\"Standard\",\"tax_total\":491,\"formatted_tax_total\":\"$4.91\",\"created_at\":\"2026-08-01T10:12:00.000000Z\",\"updated_at\":\"2026-08-14T11:02:47.000000Z\",\"placed_at\":\"2026-08-01T10:12:00.000000Z\",\"fulfilled_at\":null,\"disputed_at\":null,\"discounts\":[]}", "name": "" }, { "header": [], "code": 409, "body": "{\"message\": \"Order cannot be canceled from status canceled.\"}", "name": "Order already reached a final status" } ] } ] }, { "name": "Webhooks", "description": "", "item": [ { "name": "List webhook subscriptions", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/webhooks", "query": [ { "key": "limit", "value": "50", "description": "Results per page, 1\u2013250.", "disabled": false }, { "key": "cursor", "value": "eyJpZCI6N30", "description": "Opaque cursor from `meta.next_cursor` of the previous page.", "disabled": false } ], "raw": "{{baseUrl}}\/public\/v1\/webhooks?limit=50&cursor=eyJpZCI6N30" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 7,\n \"name\": \"Order sync\",\n \"url\": \"https:\/\/example.com\/hooks\/cartgenie\",\n \"description\": null,\n \"enabled\": true,\n \"events\": [\"new_order\", \"order_updated\"],\n \"last_dispatched_at\": \"2026-08-14T09:12:00.000000Z\",\n \"created_at\": \"2026-07-01T12:00:00.000000Z\",\n \"updated_at\": \"2026-08-14T09:12:00.000000Z\"\n }\n ],\n \"meta\": {\"per_page\": 50, \"has_more\": false, \"next_cursor\": null}\n}", "name": "" } ] }, { "name": "Get a webhook subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/webhooks\/:webhook", "query": [], "raw": "{{baseUrl}}\/public\/v1\/webhooks\/:webhook", "variable": [ { "id": "webhook", "key": "webhook", "value": 7, "description": "The subscription id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 7,\n \"name\": \"Order sync\",\n \"url\": \"https:\/\/example.com\/hooks\/cartgenie\",\n \"description\": null,\n \"enabled\": true,\n \"events\": [\"new_order\", \"order_updated\"],\n \"last_dispatched_at\": \"2026-08-14T09:12:00.000000Z\",\n \"created_at\": \"2026-07-01T12:00:00.000000Z\",\n \"updated_at\": \"2026-08-14T09:12:00.000000Z\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\"message\": \"Resource not found.\"}", "name": "Subscription belongs to another store or does not exist" } ] }, { "name": "Create a webhook subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/webhooks", "query": [], "raw": "{{baseUrl}}\/public\/v1\/webhooks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Order sync\",\"url\":\"https:\\\/\\\/example.com\\\/hooks\\\/cartgenie\",\"description\":\"Feeds our ERP\",\"enabled\":true,\"events\":[\"new_order\",\"order_updated\"]}" }, "description": "Registers a URL to receive the events you list. The URL must be a publicly\nreachable HTTPS endpoint \u2014 private and loopback addresses are rejected.\n\n## Receiving deliveries\n\nThe request body is `{\"type\": \"\", \"payload\": { ... }}`. Every delivery\ncarries a `Signature` header holding an HMAC-SHA256 of the raw JSON body,\nkeyed with your store's webhook secret from **Settings \u2192 Webhooks**. Compute\nthe same digest over the body you received and compare before trusting it.\n\nA delivery is attempted up to three times with exponential backoff and a 10\nsecond timeout, so your endpoint should answer quickly and be safe to call\ntwice with the same event.\n\n## Available events\n\n`new_order`, `order_updated`, `order_fulfillment_updated`, `new_customer`,\n`customer_updated`, `new_subscription`, `subscription_updated`,\n`new_subscription_charge`, `new_discount`, `discount_updated`,\n`new_category`, `category_updated`, `new_product`, `product_updated`,\n`new_abandoned_cart`, `refund_issued`, `inventory_updated`." }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 7,\n \"name\": \"Order sync\",\n \"url\": \"https:\/\/example.com\/hooks\/cartgenie\",\n \"description\": null,\n \"enabled\": true,\n \"events\": [\"new_order\", \"order_updated\"],\n \"last_dispatched_at\": null,\n \"created_at\": \"2026-08-14T09:12:00.000000Z\",\n \"updated_at\": \"2026-08-14T09:12:00.000000Z\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"The url must be a publicly reachable HTTPS URL.\", \"errors\": {\"url\": [\"The url must be a publicly reachable HTTPS URL.\"]}}", "name": "Endpoint is not publicly reachable over HTTPS" } ] }, { "name": "Update a webhook subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/webhooks\/:webhook", "query": [], "raw": "{{baseUrl}}\/public\/v1\/webhooks\/:webhook", "variable": [ { "id": "webhook", "key": "webhook", "value": 7, "description": "The subscription id." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Order sync\",\"url\":\"https:\\\/\\\/example.com\\\/hooks\\\/cartgenie\",\"description\":\"Feeds our ERP\",\"enabled\":false,\"events\":[\"new_order\"]}" }, "description": "Only the fields you send are changed. Sending `events` replaces the whole\nlist rather than adding to it." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 7,\n \"name\": \"Order sync\",\n \"url\": \"https:\/\/example.com\/hooks\/cartgenie\",\n \"description\": null,\n \"enabled\": false,\n \"events\": [\"new_order\"],\n \"last_dispatched_at\": \"2026-08-14T09:12:00.000000Z\",\n \"created_at\": \"2026-07-01T12:00:00.000000Z\",\n \"updated_at\": \"2026-08-15T08:30:00.000000Z\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"The url must be a publicly reachable HTTPS URL.\", \"errors\": {\"url\": [\"The url must be a publicly reachable HTTPS URL.\"]}}", "name": "Endpoint is not publicly reachable over HTTPS" } ] }, { "name": "Delete a webhook subscription", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/webhooks\/:webhook", "query": [], "raw": "{{baseUrl}}\/public\/v1\/webhooks\/:webhook", "variable": [ { "id": "webhook", "key": "webhook", "value": 7, "description": "The subscription id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "" } ] }, { "name": "Send a test delivery", "request": { "url": { "host": "{{baseUrl}}", "path": "public\/v1\/webhooks\/:webhook\/test", "query": [], "raw": "{{baseUrl}}\/public\/v1\/webhooks\/:webhook\/test", "variable": [ { "id": "webhook", "key": "webhook", "value": 7, "description": "The subscription id." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"event\":\"new_order\"}" }, "description": "Queues one delivery of the chosen event to this subscription, carrying\nrepresentative sample data rather than a real record. Use it to verify your\nendpoint and your signature check before going live.\n\nThe event must already be one this subscription listens for. The destination\nis re-validated at this point, so a URL that has since become unreachable is\nrejected here rather than failing silently later." }, "response": [ { "header": [], "code": 202, "body": "{\"queued\": true, \"event\": \"new_order\"}", "name": "" }, { "header": [], "code": 422, "body": "{\"message\": \"Event is not configured for this webhook.\"}", "name": "Subscription does not listen for that event" }, { "header": [], "code": 422, "body": "{\"message\": \"Webhook destination must be a publicly reachable HTTPS URL.\"}", "name": "Destination is no longer reachable" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }