{ "opencollection": "1.0.0", "info": { "name": "Webflow Assets Asset Folders Orders API", "version": "2.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webflow.com/oauth/authorize", "accessTokenUrl": "https://api.webflow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Webflow List Orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.webflow.com/v2/sites/:site_id/orders", "params": [ { "name": "site_id", "value": "580e63e98c9a982ac9b8b741", "type": "path", "description": "Unique identifier for a Site" }, { "name": "status", "value": "", "type": "query", "description": "Filter the orders by status" }, { "name": "offset", "value": "0", "type": "query", "description": "Offset used for pagination if the results have more than limit records" }, { "name": "limit", "value": "100", "type": "query", "description": "Maximum number of records to be returned (max limit: 100)" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webflow.com/oauth/authorize", "accessTokenUrl": "https://api.webflow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all orders created for a given site.\n\nRequired scope | `ecommerce:read`\n" }, { "info": { "name": "Webflow Get Order", "type": "http" }, "http": { "method": "GET", "url": "https://api.webflow.com/v2/sites/:site_id/orders/:order_id", "params": [ { "name": "site_id", "value": "580e63e98c9a982ac9b8b741", "type": "path", "description": "Unique identifier for a Site" }, { "name": "order_id", "value": "5e8518516e147040726cc415", "type": "path", "description": "Unique identifier for an Order" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webflow.com/oauth/authorize", "accessTokenUrl": "https://api.webflow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve a single product by its ID. All of its SKUs will also be\nretrieved.\n\nRequired scope | `ecommerce:read`\n" }, { "info": { "name": "Webflow Update Order", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.webflow.com/v2/sites/:site_id/orders/:order_id", "params": [ { "name": "site_id", "value": "580e63e98c9a982ac9b8b741", "type": "path", "description": "Unique identifier for a Site" }, { "name": "order_id", "value": "5e8518516e147040726cc415", "type": "path", "description": "Unique identifier for an Order" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webflow.com/oauth/authorize", "accessTokenUrl": "https://api.webflow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API lets you update the fields, `comment`, `shippingProvider`,\nand/or `shippingTracking` for a given order. All three fields can be\nupdated simultaneously or independently.\n\nRequired scope | `ecommerce:write`\n" }, { "info": { "name": "Webflow Fulfill Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.webflow.com/v2/sites/:site_id/orders/:order_id/fulfill", "params": [ { "name": "site_id", "value": "580e63e98c9a982ac9b8b741", "type": "path", "description": "Unique identifier for a Site" }, { "name": "order_id", "value": "5e8518516e147040726cc415", "type": "path", "description": "Unique identifier for an Order" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webflow.com/oauth/authorize", "accessTokenUrl": "https://api.webflow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an order's status to fulfilled\n\nRequired scope | `ecommerce:write`\n" }, { "info": { "name": "Webflow Unfulfill Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.webflow.com/v2/sites/:site_id/orders/:order_id/unfulfill", "params": [ { "name": "site_id", "value": "580e63e98c9a982ac9b8b741", "type": "path", "description": "Unique identifier for a Site" }, { "name": "order_id", "value": "5e8518516e147040726cc415", "type": "path", "description": "Unique identifier for an Order" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webflow.com/oauth/authorize", "accessTokenUrl": "https://api.webflow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an order's status to unfulfilled\n\nRequired scope | `ecommerce:write`\n" }, { "info": { "name": "Webflow Refund Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.webflow.com/v2/sites/:site_id/orders/:order_id/refund", "params": [ { "name": "site_id", "value": "580e63e98c9a982ac9b8b741", "type": "path", "description": "Unique identifier for a Site" }, { "name": "order_id", "value": "5e8518516e147040726cc415", "type": "path", "description": "Unique identifier for an Order" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webflow.com/oauth/authorize", "accessTokenUrl": "https://api.webflow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This API will reverse a Stripe charge and refund an order back to a\ncustomer. It will also set the order's status to `refunded`.\n\nRequired scope | `ecommerce:write`\n" } ] } ], "bundled": true }