Models

AuthorizedUser

Properties

Field	Type	Description
`_id`	string	The unique id of the user
`email`	string	The user's email address
`firstName`	string	The user's first name
`lastName`	string	The user's last name

Example

{
	"user": {
		"_id": "545bbecb7bdd6769632504a7",
		"email": "[email protected]",
		"firstName": "Some",
		"lastName": "One"
	}
}

Authorization

Properties

Field	Type	Description
`_id`	string	The unique id of the authorization
`createdOn`	string	The date the authorization was created
`grantType`	string	The grant type of the authorization
`lastUsed`	string	The date the authorization was last used
`sites`	[string]	The sites authorized
`orgs`	[string]	The organizations authorized
`workspaces`	[string]	The workspaces authorized
`users`	[string]	The users authorized
`rateLimit`	integer	The default rate limit for the authorization
`status`	string	The status of the authorization
`application`	Application	An instance of the Application object.

Example

{
	"_id": "55818d58616600637b9a5786",
	"createdOn": "2016-10-03T23:12:00.755Z",
	"grantType": "authorization_code",
	"lastUsed": "2016-10-10T21:41:12.736Z",
	"sites": [
		"62f3b1f7eafac55d0c64ef91"
	],
	"orgs": [
		"551ad253f0a9c0686f71ed08"
	],
	"workspaces": [],
	"users": [
		"545bbecb7bdd6769632504a7"
	],
	"rateLimit": 60,
	"status": "confirmed",
	"application": {
		"_id": "55131cd036c09f7d07883dfc",
		"description": "OAuth Testing Application",
		"homepage": "https://webflow.com",
		"name": "Test App",
		"owner": "545bbecb7bdd6769632504a7",
		"ownerType": "Person"
	}
}

Application

Properties

Field	Type	Description
`_id`	string
`description`	string
`homepage`	string
`name`	string
`owner`	string
`ownerType`	string

Example

{}

Site

Properties

Field	Type	Description
`_id`	string	Unique identifier for site
`createdOn`	string	Date the site was created
`name`	string	Name given to site
`shortName`	string	Slugified version of name
`lastPublished`	string	Date site was last published
`previewUrl`	string	URL of a generated image for the given site
`timezone`	string	Site timezone set under Site Settings

Example

{
	"_id": "580e63e98c9a982ac9b8b741",
	"createdOn": "2016-10-24T19:41:29.156Z",
	"name": "api_docs_sample_json",
	"shortName": "api-docs-sample-json",
	"lastPublished": "2016-10-24T19:43:17.271Z",
	"previewUrl": "https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241243.png",
	"timezone": "America/Los_Angeles",
	"database": "580e63fc8c9a982ac9b8b744"
}

Domain

Properties

Field	Type	Description
`_id`	string	Unique identifier for domain
`name`	string	The domain name

Example

{}

PublishedSite

Properties

Field	Type	Description
`queued`	boolean	Indicates if the site has been queued for publish

Example

{
	"queued": true
}

Collection

Properties

Field	Type	Description
`_id`	string	Unique identifier for collection
`lastUpdated`	string	The date the collection was last updated
`createdOn`	string	The date the collection was create
`name`	string	Name given to Collection
`slug`	string	Slug of Collection in Site URL structure
`singularName`	string	The name of one Item in Collection (e.g. “post” if the Collection is called “Posts”)
`fields`	[Field]	The list of fields in the collection

Example

{
	"_id": "580e63fc8c9a982ac9b8b745",
	"lastUpdated": "2016-10-24T19:42:38.929Z",
	"createdOn": "2016-10-24T19:41:48.349Z",
	"name": "Blog Posts",
	"slug": "post",
	"singularName": "Blog Post",
	"fields": [
		{
			"id": "7f62a9781291109b9e428fb47239fd35",
			"editable": true,
			"required": false,
			"type": "RichText",
			"slug": "post-body",
			"name": "Post Body"
		},
		{
			"validations": {
				"singleLine": false
			},
			"id": "ac4ffead755a78c710c44042f528b073",
			"helpText": "A summary of the blog post that appears on blog post grid",
			"editable": true,
			"required": false,
			"type": "PlainText",
			"slug": "post-summary",
			"name": "Post Summary"
		},
		{
			"id": "ba1cfbdaa6b38b8e95e9b5063da8a5bd",
			"editable": true,
			"required": false,
			"type": "ImageRef",
			"slug": "main-image",
			"name": "Main Image"
		},
		{
			"id": "a8c6ea29b08cc5b5ef966908fa1deae2",
			"helpText": "Smaller version of main image that is used on blog post grid",
			"editable": true,
			"required": false,
			"type": "ImageRef",
			"slug": "thumbnail-image",
			"name": "Thumbnail image"
		},
		{
			"id": "87e79a644a6fb5729940ec24e0012f01",
			"editable": true,
			"required": false,
			"type": "Set",
			"innerType": "ImageRef",
			"slug": "picture-gallery",
			"name": "Picture Gallery"
		},
		{
			"id": "1e54974d97181032d3206ea021668e5f",
			"editable": true,
			"required": false,
			"type": "Bool",
			"slug": "featured",
			"name": "Featured?"
		},
		{
			"id": "648463cbc042ab079c2b99430a398ae5",
			"editable": true,
			"required": false,
			"type": "Color",
			"slug": "color",
			"name": "Color"
		},
		{
			"validations": {
				"collectionId": "580e64088c9a982ac9b8b766"
			},
			"id": "ea9067c48edee510de71fe503fa2fb51",
			"editable": true,
			"required": false,
			"type": "ItemRef",
			"slug": "author",
			"name": "Author"
		},
		{
			"validations": {
				"maxLength": 256
			},
			"id": "60c0667e27b6d5a6daedec3a641265f6",
			"editable": true,
			"required": true,
			"type": "PlainText",
			"slug": "name",
			"name": "Name"
		},
		{
			"validations": {
				"messages": {
					"maxLength": "Must be less than 256 characters",
					"pattern": "Must be alphanumerical and not contain any spaces or special characters"
				},
				"pattern": {},
				"maxLength": 256
			},
			"id": "8f0c953df91d10b767d66e1d7d00d631",
			"unique": true,
			"editable": true,
			"required": true,
			"type": "PlainText",
			"slug": "slug",
			"name": "Slug"
		},
		{
			"default": false,
			"id": "e4e92e700d70faffac6fa82ff2bfaece",
			"editable": true,
			"required": true,
			"type": "Bool",
			"slug": "_archived",
			"name": "Archived"
		},
		{
			"default": false,
			"id": "f2675b2ac4fcef746b24d4a320887ef8",
			"editable": true,
			"required": true,
			"type": "Bool",
			"slug": "_draft",
			"name": "Draft"
		},
		{
			"id": "0913a35d92208bdf8fbf3ed1e39b771e",
			"editable": false,
			"required": false,
			"type": "Date",
			"slug": "created-on",
			"name": "Created On"
		},
		{
			"id": "3de04889465fe6d718e47b152ef5bb4d",
			"editable": false,
			"required": false,
			"type": "Date",
			"slug": "updated-on",
			"name": "Updated On"
		},
		{
			"id": "2a3cd866d5dbb294896130b233218626",
			"editable": false,
			"required": false,
			"type": "Date",
			"slug": "published-on",
			"name": "Published On"
		},
		{
			"id": "62c18561b9e89517751c6d8712d48f91",
			"editable": false,
			"required": false,
			"type": "User",
			"slug": "created-by",
			"name": "Created By"
		},
		{
			"id": "50918093b4e4d4eca1e83c25bcdc06a4",
			"editable": false,
			"required": false,
			"type": "User",
			"slug": "updated-by",
			"name": "Updated By"
		},
		{
			"id": "5c4587f18b32ef245daeaadfcba7860b",
			"editable": false,
			"required": false,
			"type": "User",
			"slug": "published-by",
			"name": "Published By"
		}
	]
}

CollectionItem

Properties

Field	Type	Description
`_archived`	boolean	Boolean determining if the Item is set to archived
`_draft`	boolean	Boolean determining if the Item is set to draft
`_id`	string	Unique identifier for the Item
`_cid`	string	Unique identifier for the Collection the Item belongs within
`name`	string	Name given to the Item
`slug`	string	URL structure of the Item in your site. Note: Updates to an item slug will break all links referencing the old slug.

Example

{
	"_archived": false,
	"_draft": false,
	"color": "#a98080",
	"name": "Exciting blog post title",
	"post-body": "<p>Blog post contents...</p>",
	"post-summary": "Summary of exciting blog post",
	"main-image": {
		"fileId": "580e63fe8c9a982ac9b8b749",
		"url": "https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg"
	},
	"slug": "exciting-post",
	"author": "580e640c8c9a982ac9b8b778",
	"updated-on": "2016-11-15T22:45:32.647Z",
	"updated-by": "Person_5660c5338e9d3b0bee3b86aa",
	"created-on": "2016-11-15T22:45:32.647Z",
	"created-by": "Person_5660c5338e9d3b0bee3b86aa",
	"published-on": null,
	"published-by": null,
	"_cid": "580e63fc8c9a982ac9b8b745",
	"_id": "582b900cba19143b2bb8a759"
}

CollectionItemList

Properties

Field	Type	Description
`items`	[CollectionItem]	List of Items within the collection
`count`	number	Number of items returned
`limit`	number	The limit specified in the request
`offset`	number	The offset specified for pagination
`total`	number	Total number of items in the collection

Example

{
	"items": [
		{
			"_archived": false,
			"_draft": false,
			"color": "#a98080",
			"name": "Exciting blog post title",
			"post-body": "<p>Blog post contents...</p>",
			"post-summary": "Summary of exciting blog post",
			"main-image": {
				"fileId": "580e63fe8c9a982ac9b8b749",
				"url": "https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg"
			},
			"slug": "exciting-post",
			"author": "580e640c8c9a982ac9b8b778",
			"updated-on": "2016-11-15T22:45:32.647Z",
			"updated-by": "Person_5660c5338e9d3b0bee3b86aa",
			"created-on": "2016-11-15T22:45:32.647Z",
			"created-by": "Person_5660c5338e9d3b0bee3b86aa",
			"published-on": null,
			"published-by": null,
			"_cid": "580e63fc8c9a982ac9b8b745",
			"_id": "582b900cba19143b2bb8a759"
		}
	],
	"count": 1,
	"limit": 1,
	"offset": 0,
	"total": 5
}

PublishedItems

Properties

Field	Type	Description
`publishedItemIds`	[string]	Array of published item ids
`errors`	[string]	Array of errors

Example

{
	"publishedItemIds": [
		"62aa37923cf7a9de1ca4469c",
		"62aa37923cf7a9de1ca44697",
		"62aa37923cf7a9de1ca44696"
	],
	"errors": []
}

RemovedItems

Properties

Field	Type	Description
`deletedItemIds`	[string]	Array of deleted item ids
`errors`	[string]	Array of errors

Example

{
	"deletedItemIds": [
		"62aa37923cf7a9de1ca4469c",
		"62aa37923cf7a9de1ca44697",
		"62aa37923cf7a9de1ca44696"
	],
	"errors": []
}

User

Properties

Field	Type	Description
`_id`	string	Unique identifier for the User
`createdOn`	string	The timestamp the user was created
`updatedOn`	string	The timestamp the user was updated
`invitedOn`	string	The timestamp the user was invited
`lastLogin`	string	The timestamp the user was logged in
`emailVerified`	boolean	Shows whether the user has verified their email address
`status`	string	The status of the user
`data`	object	An object containing the User's basic info and custom fields

Example

{
	"_id": "6287ec36a841b25637c663df",
	"createdOn": "2022-05-20T13:46:12.093Z",
	"updatedOn": "2022-05-20T13:46:12.093Z",
	"emailVerified": true,
	"status": "verified",
	"data": {
		"accept-privacy": false,
		"accept-communications": false,
		"email": "[email protected]",
		"name": "Some One"
	}
}

UserList

Properties

Field	Type	Description
`count`	number	Number of users returned
`limit`	number	The limit specified in the request
`offset`	number	The offset specified for pagination
`total`	number	Total number of users in the collection
`users`	[User]	List of Users for a Site

Example

{
	"users": [
		{
			"_id": "6287ec36a841b25637c663df",
			"createdOn": "2022-05-20T13:46:12.093Z",
			"updatedOn": "2022-05-20T13:46:12.093Z",
			"emailVerified": false,
			"status": "unverified",
			"data": {
				"accept-privacy": false,
				"accept-communications": false,
				"email": "[email protected]",
				"name": "Person One"
			}
		},
		{
			"_id": "6287ec36a841b25637c663f0",
			"createdOn": "2022-05-19T05:32:04.581Z",
			"updatedOn": "2022-05-19T05:32:04.581Z",
			"emailVerified": false,
			"status": "unverified",
			"data": {
				"accept-privacy": false,
				"accept-communications": false,
				"email": "[email protected]",
				"name": "Person Two"
			}
		},
		{
			"_id": "6287ec36a841b25637c663d9",
			"createdOn": "2022-05-17T03:34:06.720Z",
			"updatedOn": "2022-05-17T03:34:06.720Z",
			"emailVerified": true,
			"status": "verified",
			"data": {
				"accept-privacy": false,
				"accept-communications": false,
				"email": "[email protected]",
				"name": "Person Three"
			}
		},
		{
			"_id": "6287ec37a841b25637c6641b",
			"createdOn": "2022-05-15T03:46:09.748Z",
			"updatedOn": "2022-05-15T03:46:09.748Z",
			"emailVerified": false,
			"status": "unverified",
			"data": {
				"accept-privacy": false,
				"accept-communications": false,
				"email": "[email protected]",
				"name": "Person Four"
			}
		},
		{
			"_id": "6287ec37a841b25637c66449",
			"createdOn": "2022-05-15T02:55:38.786Z",
			"updatedOn": "2022-05-15T02:55:38.786Z",
			"emailVerified": true,
			"status": "verified",
			"data": {
				"accept-privacy": false,
				"accept-communications": false,
				"email": "[email protected]",
				"name": "Person Five"
			}
		}
	],
	"count": 5,
	"limit": 5,
	"offset": 0,
	"total": 201
}

AccessGroup

Properties

Field	Type	Description
`_id`	string	Unique identifier for the Access Group
`name`	string	Name of the the Access Group
`shortId`	string	Shortened unique identifier based on name, optimized for its use in the user’s JWT
`slug`	string	Shortened unique identifier based on name, optimized for human readability and public API use
`createdOn`	string	The date the Access Group was created

Example

{
	"_id": "62be58d404be8a6cc900c081",
	"name": "Webflowers",
	"shortId": "jo",
	"slug": "webflowers",
	"createdOn": "2022-08-01T19:41:48.349Z"
}

AccessGroupList

Properties

Field	Type	Description
`count`	number	Number of access groups returned
`limit`	number	The limit specified in the request
`offset`	number	The offset specified for pagination
`total`	number	Total number of access groups in the collection
`accessGroups`	[AccessGroup]	List of Site Access Groups

Example

{
	"accessGroups": [
		{
			"_id": "62be58d404be8a6cc900c081",
			"name": "Webflowers",
			"shortId": "jo",
			"slug": "webflowers",
			"createdOn": "2022-08-01T19:41:48.349Z"
		}
	],
	"count": 1,
	"limit": 10,
	"offset": 0,
	"total": 1
}

Product

Properties

Field	Type	Description
`_id`	string	Unique identifier for collection
`lastUpdated`	string	The date the collection was last updated
`createdOn`	string	The date the collection was create
`name`	string	Name given to Collection
`slug`	string	Slug of Collection in Site URL structure
`singularName`	string	The name of one Item in Collection (e.g. “product” if the Collection is called “Product”)

`fields`	[Field]	The list of fields in the collection

Example

{
	"shippable": true,
	"_archived": false,
	"_draft": false,
	"name": "Cloak Of Invisibility",
	"ec-product-type": "ff42fee0113744f693a764e3431a9cc2",
	"sku-properties": [
		{
			"id": "a37a7991f7ca1be0d349a805a2bddb5b",
			"name": "Color",
			"enum": [
				{
					"id": "a9506da8e70a8b087f35a4094ec34a53",
					"name": "Obsidian Black",
					"slug": "obsidian-black"
				},
				{
					"id": "c92a465a1298c95fd1cd7f4c1c96c2ba",
					"name": "Smoke Grey",
					"slug": "smoke-grey"
				},
				{
					"id": "ef9511c0b56cc11ff47c5669f65030b4",
					"name": "Forest Green",
					"slug": "forest-green"
				}
			]
		}
	],
	"description": "A cloak that renders the wearer invisible to the eye.",
	"slug": "cloak-of-invisibility-1",
	"updated-on": "2020-04-01T22:40:19.329Z",
	"updated-by": "Person_5d8fcb6d94dd1853060fb3b3",
	"created-on": "2020-04-01T22:40:17.602Z",
	"created-by": "Person_5d8fcb6d94dd1853060fb3b3",
	"published-on": null,
	"published-by": null,
	"default-sku": "5e8518536e147040726cc416",
	"_cid": "5dd44c493543b37d5449b3a5",
	"_id": "5e8518516e147040726cc415"
}

ProductList

Properties

Field	Type	Description
`items`	[Product]	List of Item objects within the Collection. Contains product and skus keys
`count`	number	Number of items returned
`limit`	number	The limit specified in the request
`offset`	number	The offset specified for pagination
`total`	number	Total number of items in the collection

Example

{
	"items": [
		{
			"product": {
				"shippable": true,
				"_archived": false,
				"_draft": false,
				"name": "Cloak Of Invisibility",
				"ec-product-type": "ff42fee0113744f693a764e3431a9cc2",
				"sku-properties": [
					{
						"id": "a37a7991f7ca1be0d349a805a2bddb5b",
						"name": "Color",
						"enum": [
							{
								"id": "a9506da8e70a8b087f35a4094ec34a53",
								"name": "Obsidian Black",
								"slug": "obsidian-black"
							},
							{
								"id": "c92a465a1298c95fd1cd7f4c1c96c2ba",
								"name": "Smoke Grey",
								"slug": "smoke-grey"
							},
							{
								"id": "ef9511c0b56cc11ff47c5669f65030b4",
								"name": "Forest Green",
								"slug": "forest-green"
							}
						]
					}
				],
				"description": "A cloak that renders the wearer invisible to the eye.",
				"slug": "cloak-of-invisibility-1",
				"updated-on": "2020-04-01T22:40:19.329Z",
				"updated-by": "Person_5d8fcb6d94dd1853060fb3b3",
				"created-on": "2020-04-01T22:40:17.602Z",
				"created-by": "Person_5d8fcb6d94dd1853060fb3b3",
				"published-on": null,
				"published-by": null,
				"default-sku": "5e8518536e147040726cc416",
				"_cid": "5dd44c493543b37d5449b3a5",
				"_id": "5e8518516e147040726cc415"
			},
			"skus": [
				{
					"price": {
						"unit": "USD",
						"value": 120000
					},
					"_archived": false,
					"_draft": false,
					"sku-values": {},
					"width": 56,
					"length": 0.3,
					"height": 72,
					"weight": 24,
					"name": "Cloak Of Invisibility Color: Obsidian Black",
					"main-image": {
						"fileId": "5e85161dabd9ea4072cf1414",
						"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
						"alt": null
					},
					"more-images": [
						{
							"fileId": "5e85161dabd9ea4072cf1414",
							"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
							"alt": null
						},
						{
							"fileId": "5e85161dabd9ea4072cf1414",
							"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
							"alt": null
						}
					],
					"download-files": [
						{
							"id": "5ebb1676c3244c2c6ae18814",
							"name": "The modern web design process - Webflow Ebook.pdf",
							"url": "https://dropbox.com/files/modern-web-design-process.pdf"
						}
					],
					"slug": "cloak-of-invisibility-color-obsidian-black-7",
					"product": "5e8518516e147040726cc415",
					"updated-on": "2020-04-01T22:40:19.287Z",
					"updated-by": "Person_5d8fcb6d94dd1853060fb3b3",
					"created-on": "2020-04-01T22:40:19.287Z",
					"created-by": "Person_5d8fcb6d94dd1853060fb3b3",
					"published-on": null,
					"published-by": null,
					"_cid": "5dd44c493543b37d5449b383",
					"_id": "5e8518536e147040726cc416"
				}
			]
		}
	],
	"count": 1,
	"limit": 100,
	"offset": 0,
	"total": 12
}

ProductSKU

Properties

Field	Type	Description
`product`	Product	An instance of the Product object.
`sku`	SKU	An instance of the SKU object.

Example

{
	"product": {
		"shippable": true,
		"_archived": false,
		"_draft": false,
		"name": "Cloak Of Invisibility",
		"ec-product-type": "ff42fee0113744f693a764e3431a9cc2",
		"sku-properties": [
			{
				"id": "a37a7991f7ca1be0d349a805a2bddb5b",
				"name": "Color",
				"enum": [
					{
						"id": "a9506da8e70a8b087f35a4094ec34a53",
						"name": "Obsidian Black",
						"slug": "obsidian-black"
					},
					{
						"id": "c92a465a1298c95fd1cd7f4c1c96c2ba",
						"name": "Smoke Grey",
						"slug": "smoke-grey"
					},
					{
						"id": "ef9511c0b56cc11ff47c5669f65030b4",
						"name": "Forest Green",
						"slug": "forest-green"
					}
				]
			}
		],
		"description": "A cloak that renders the wearer invisible to the eye.",
		"slug": "cloak-of-invisibility-1",
		"updated-on": "2020-04-01T22:40:19.329Z",
		"updated-by": "Person_5d8fcb6d94dd1853060fb3b3",
		"created-on": "2020-04-01T22:40:17.602Z",
		"created-by": "Person_5d8fcb6d94dd1853060fb3b3",
		"published-on": null,
		"published-by": null,
		"default-sku": "5e8518536e147040726cc416",
		"_cid": "5dd44c493543b37d5449b3a5",
		"_id": "5e8518516e147040726cc415"
	},
	"sku": {
		"price": {
			"unit": "USD",
			"value": 120000
		},
		"_archived": false,
		"_draft": false,
		"sku-values": {},
		"width": 56,
		"length": 0.3,
		"height": 72,
		"weight": 24,
		"name": "Cloak Of Invisibility Color: Obsidian Black",
		"main-image": {
			"fileId": "5e85161dabd9ea4072cf1414",
			"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
			"alt": null
		},
		"more-images": [
			{
				"fileId": "5e85161dabd9ea4072cf1414",
				"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
				"alt": null
			},
			{
				"fileId": "5e85161dabd9ea4072cf1414",
				"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
				"alt": null
			}
		],
		"download-files": [
			{
				"id": "5ebb1676c3244c2c6ae18814",
				"name": "The modern web design process - Webflow Ebook.pdf",
				"url": "https://dropbox.com/files/modern-web-design-process.pdf"
			}
		],
		"slug": "cloak-of-invisibility-color-obsidian-black-7",
		"product": "5e8518516e147040726cc415",
		"updated-on": "2020-04-01T22:40:19.287Z",
		"updated-by": "Person_5d8fcb6d94dd1853060fb3b3",
		"created-on": "2020-04-01T22:40:19.287Z",
		"created-by": "Person_5d8fcb6d94dd1853060fb3b3",
		"published-on": null,
		"published-by": null,
		"_cid": "5dd44c493543b37d5449b383",
		"_id": "5e8518536e147040726cc416"
	}
}

ProductSKUList

Properties

Field	Type	Description
`items`	[Product]	List of SKUs for a Product
`count`	number	Number of items returned
`limit`	number	The limit specified in the request
`offset`	number	The offset specified for pagination
`total`	number	Total number of items in the collection

Example

{
	"items": [
		{
			"product": {
				"shippable": true,
				"_archived": false,
				"_draft": false,
				"name": "Cloak Of Invisibility",
				"ec-product-type": "ff42fee0113744f693a764e3431a9cc2",
				"sku-properties": [
					{
						"id": "a37a7991f7ca1be0d349a805a2bddb5b",
						"name": "Color",
						"enum": [
							{
								"id": "a9506da8e70a8b087f35a4094ec34a53",
								"name": "Obsidian Black",
								"slug": "obsidian-black"
							},
							{
								"id": "c92a465a1298c95fd1cd7f4c1c96c2ba",
								"name": "Smoke Grey",
								"slug": "smoke-grey"
							},
							{
								"id": "ef9511c0b56cc11ff47c5669f65030b4",
								"name": "Forest Green",
								"slug": "forest-green"
							}
						]
					}
				],
				"description": "A cloak that renders the wearer invisible to the eye.",
				"slug": "cloak-of-invisibility-1",
				"updated-on": "2020-04-01T22:40:19.329Z",
				"updated-by": "Person_5d8fcb6d94dd1853060fb3b3",
				"created-on": "2020-04-01T22:40:17.602Z",
				"created-by": "Person_5d8fcb6d94dd1853060fb3b3",
				"published-on": null,
				"published-by": null,
				"default-sku": "5e8518536e147040726cc416",
				"_cid": "5dd44c493543b37d5449b3a5",
				"_id": "5e8518516e147040726cc415"
			},
			"skus": [
				{
					"price": {
						"unit": "USD",
						"value": 120000
					},
					"_archived": false,
					"_draft": false,
					"sku-values": {},
					"width": 56,
					"length": 0.3,
					"height": 72,
					"weight": 24,
					"name": "Cloak Of Invisibility Color: Obsidian Black",
					"main-image": {
						"fileId": "5e85161dabd9ea4072cf1414",
						"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
						"alt": null
					},
					"more-images": [
						{
							"fileId": "5e85161dabd9ea4072cf1414",
							"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
							"alt": null
						},
						{
							"fileId": "5e85161dabd9ea4072cf1414",
							"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
							"alt": null
						}
					],
					"download-files": [
						{
							"id": "5ebb1676c3244c2c6ae18814",
							"name": "The modern web design process - Webflow Ebook.pdf",
							"url": "https://dropbox.com/files/modern-web-design-process.pdf"
						}
					],
					"slug": "cloak-of-invisibility-color-obsidian-black-7",
					"product": "5e8518516e147040726cc415",
					"updated-on": "2020-04-01T22:40:19.287Z",
					"updated-by": "Person_5d8fcb6d94dd1853060fb3b3",
					"created-on": "2020-04-01T22:40:19.287Z",
					"created-by": "Person_5d8fcb6d94dd1853060fb3b3",
					"published-on": null,
					"published-by": null,
					"_cid": "5dd44c493543b37d5449b383",
					"_id": "5e8518536e147040726cc416"
				}
			]
		}
	],
	"count": 1,
	"limit": 100,
	"offset": 0,
	"total": 12
}

SKU

Properties

Field	Type	Description
`_id`	string	Unique identifier for collection
`lastUpdated`	string	The date the collection was last updated
`createdOn`	string	The date the collection was create
`name`	string	Name given to Collection
`slug`	string	Slug of Collection in Site URL structure
`singularName`	string	The name of one Item in Collection (e.g. “sku” if the Collection is called “SKU”)
`fields`	[Field]	The list of fields in the collection

Example

{
	"price": {
		"unit": "USD",
		"value": 120000
	},
	"_archived": false,
	"_draft": false,
	"sku-values": {},
	"width": 56,
	"length": 0.3,
	"height": 72,
	"weight": 24,
	"name": "Cloak Of Invisibility Color: Obsidian Black",
	"main-image": {
		"fileId": "5e85161dabd9ea4072cf1414",
		"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
		"alt": null
	},
	"more-images": [
		{
			"fileId": "5e85161dabd9ea4072cf1414",
			"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
			"alt": null
		},
		{
			"fileId": "5e85161dabd9ea4072cf1414",
			"url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg",
			"alt": null
		}
	],
	"download-files": [
		{
			"id": "5ebb1676c3244c2c6ae18814",
			"name": "The modern web design process - Webflow Ebook.pdf",
			"url": "https://dropbox.com/files/modern-web-design-process.pdf"
		}
	],
	"slug": "cloak-of-invisibility-color-obsidian-black-7",
	"product": "5e8518516e147040726cc415",
	"updated-on": "2020-04-01T22:40:19.287Z",
	"updated-by": "Person_5d8fcb6d94dd1853060fb3b3",
	"created-on": "2020-04-01T22:40:19.287Z",
	"created-by": "Person_5d8fcb6d94dd1853060fb3b3",
	"published-on": null,
	"published-by": null,
	"_cid": "5dd44c493543b37d5449b383",
	"_id": "5e8518536e147040726cc416"
}

SKUList

Properties

Field	Type	Description
`skus`	[SKU]

Example

{
	"skus": [
		{
			"slug": "cloak-of-invisibility-color-smoke-grey",
			"_archived": false,
			"_draft": false,
			"price": {
				"unit": "USD",
				"value": 120000
			},
			"more-images": [],
			"download-files": [
				{
					"id": "5ebb1945c3244c2c6ae18822",
					"name": "The modern web design process - Webflow Ebook.pdf",
					"url": "https://dropbox.com/files/modern-web-design-process.pdf"
				}
			],
			"sku-values": {
				"a37a7991f7ca1be0d349a805a2bddb5b": "c92a465a1298c95fd1cd7f4c1c96c2ba"
			},
			"width": 56,
			"length": 0.3,
			"height": 72,
			"weight": 24,
			"name": "Cloak Of Invisibility Color: Smoke Grey",
			"main-image": {
				"fileId": "5e8512181ae993035b15f315",
				"file": {
					"_id": "5e8512181ae993035b15f315",
					"variants": [
						{
							"_id": "5e85121b1ae993035b15f316",
							"origFileName": "external-content.duckduckgo.com-p-500.jpeg",
							"fileName": "5e8512181ae993035b15f315_external-content.duckduckgo.com-p-500.jpeg",
							"format": "jpeg",
							"size": 54068,
							"width": 500,
							"quality": 100,
							"s3Url": "https://s3.amazonaws.com/webflow-dev-assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com-p-500.jpeg"
						}
					],
					"origFileName": "invisibility_cloak.jpg",
					"fileName": "5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg",
					"fileHash": "860b1b99ce90aa6c175bfcd9fd59fd42",
					"s3Url": "https://s3.amazonaws.com/webflow-dev-assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg",
					"mimeType": "image/jpeg",
					"size": 192263,
					"width": 550,
					"height": 550,
					"database": "5e8402eb8a402e354bd469bb",
					"createdOn": "2020-04-01T22:13:44.889Z",
					"__v": 1,
					"updatedOn": "2020-04-01T22:13:59.777Z"
				},
				"fileSize": 192263,
				"url": "https://d1otoma47x30pg.cloudfront.net/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg",
				"alt": null
			},
			"product": "5e8518516e147040726cc415",
			"updated-on": "2020-04-03T18:50:45.947Z",
			"updated-by": "Person_5d8fcb6d94dd1853060fb3b3",
			"created-on": "2020-04-03T18:50:45.947Z",
			"created-by": "Person_5d8fcb6d94dd1853060fb3b3",
			"published-on": null,
			"published-by": null,
			"_cid": "5e8402eb8a402e354bd469be",
			"_id": "5e8785855617d73f34627a93"
		},
		{
			"_archived": false,
			"_draft": false,
			"price": {
				"unit": "USD",
				"value": 120000
			},
			"more-images": [],
			"download-files": [
				{
					"id": "5ebb1945c3244c2c6ae18823",
					"name": "The modern web design process - Webflow Ebook.pdf",
					"url": "https://dropbox.com/files/modern-web-design-process.pdf"
				}
			],
			"sku-values": {
				"a37a7991f7ca1be0d349a805a2bddb5b": "ef9511c0b56cc11ff47c5669f65030b4"
			},
			"width": 56,
			"length": 0.3,
			"height": 72,
			"weight": 24,
			"name": "Cloak Of Invisibility Color: Forest Green",
			"main-image": {
				"fileId": "5e8512181ae993035b15f315",
				"file": {
					"_id": "5e8512181ae993035b15f315",
					"variants": [
						{
							"_id": "5e85121b1ae993035b15f316",
							"origFileName": "external-content.duckduckgo.com-p-500.jpeg",
							"fileName": "5e8512181ae993035b15f315_external-content.duckduckgo.com-p-500.jpeg",
							"format": "jpeg",
							"size": 54068,
							"width": 500,
							"quality": 100,
							"s3Url": "https://s3.amazonaws.com/webflow-dev-assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com-p-500.jpeg"
						}
					],
					"origFileName": "invisibility_cloak.jpg",
					"fileName": "5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg",
					"fileHash": "860b1b99ce90aa6c175bfcd9fd59fd42",
					"s3Url": "https://s3.amazonaws.com/webflow-dev-assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg",
					"mimeType": "image/jpeg",
					"size": 192263,
					"width": 550,
					"height": 550,
					"database": "5e8402eb8a402e354bd469bb",
					"createdOn": "2020-04-01T22:13:44.889Z",
					"__v": 1,
					"updatedOn": "2020-04-01T22:13:59.777Z"
				},
				"fileSize": 192263,
				"url": "https://d1otoma47x30pg.cloudfront.net/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg",
				"alt": null
			},
			"slug": "cloak-of-invisibility-color-forest-green",
			"product": "5e8518516e147040726cc415",
			"updated-on": "2020-04-03T18:50:45.949Z",
			"updated-by": "Person_5d8fcb6d94dd1853060fb3b3",
			"created-on": "2020-04-03T18:50:45.949Z",
			"created-by": "Person_5d8fcb6d94dd1853060fb3b3",
			"published-on": null,
			"published-by": null,
			"_cid": "5e8402eb8a402e354bd469be",
			"_id": "5e8785855617d73f34627a94"
		}
	]
}

Field

Properties

Field	Type	Description
`id`	string	Unique identifier for the field
`slug`	string	Slug of the field in the URL structure of your site for template pages
`name`	string	Name given to the field
`type`	FieldType	An instance of the FieldType object.
`editable`	boolean	Determines if field is editable (some fields are automatically created and cannot be edited)
`required`	boolean	Determines if field is required
`validations`	Validation	An instance of the Validation object.

Example

{
	"name": "Exciting blog post title",
	"slug": "exciting-post",
	"_archived": false,
	"_draft": false,
	"color": "#a98080",
	"author": "580e640c8c9a982ac9b8b778",
	"post-body": "<p>Blog post contents...</p>",
	"post-summary": "Summary of exciting blog post",
	"main-image": "580e63fe8c9a982ac9b8b749"
}

InnerFieldType

Properties

Inner field types follow the same rules as field types, but are used to describe the type of a “Set” field Array element. They may use slightly different names in the Designer and Editor and have an “alt name” listed here which is the name of the field we publicly display. (For the API however, we only use the actual name of the field type).

Value	Description
`ExtFileRef`	An object containing name (string) and URL (string) properties
`ImageRef`	Unique id for images in CMS

FieldType

Properties

Value	Description
`Bool`	Yes/no switch used for filtering data that's displayed in your site, ex: `featured`
`Color`	CSS Color value (ie: `'red'` or `'#e3e3e3'`)
`Date`	Date field used to display any combination of month, day, year, and time
`ExtFileRef`	An object containing name (string) and URL (string) properties
`Set`	Field containing multiple objects for external files
`ImageRef`	Unique id for images in CMS
`Set`	Field containing multiple unique ids for images in CMS
`ItemRef`	Field containing item referenced from another Collection
`ItemRefSet`	Field containing multiple items referenced from another Collection
`Link`	URL field where the value can be used as a link destination for buttons, link text, and link blocks
`Number`	Single line input field used only for numbers
`Option`	Dropdown field with multiple options
`PlainText`	Unformatted text (no images, styles, etc.)
`RichText`	Formatted text (with headers, hyperlinks, images, etc.)
`Video`	Video link field used to embed videos from YouTube and Vimeo

Validation

Properties

Field	Type	Description
`maxLength`	number
`minLength`	number
`minimum`	number
`maximum`	number
`maxSize`	number
`decimalPlaces`	number
`singleLine`	boolean
`options`	[string]
`format`	string
`precision`	number
`allowNegative`	boolean
`collectionId`	string

Example

{
	"singleLine": false,
	"maxLength": 256,
	"messages": {
		"maxLength": "Must be less than 256 characters",
		"pattern": "Must be alphanumerical and not contain any spaces or special characters"
	},
	"pattern": {}
}

CategoryCollection

Properties

Field	Type	Description
`_id`	string	Unique identifier for collection
`lastUpdated`	string	The date the collection was last updated
`createdOn`	string	The date the collection was create
`name`	string	Name given to Collection
`slug`	string	Slug of Collection in Site URL structure
`singularName`	string	The name of one Item in Collection (e.g. “category” if the Collection is called “Category”)
`fields`	[Field]	The list of fields in the collection

Example

{
	"_id": "5e8402eb8a402e354bd469bc",
	"name": "Categories",
	"slug": "category",
	"singularName": "Category",
	"createdOn": "2020-04-01T02:56:43.638Z",
	"lastUpdated": "2020-04-01T02:56:43.690Z",
	"fields": [
		{
			"id": "a624247e3528136a36a8b1c5dbdc2632",
			"name": "Name",
			"slug": "name",
			"type": "PlainText",
			"required": true,
			"editable": true,
			"validations": {
				"maxLength": 256
			}
		},
		{
			"id": "7c3fbdf76e7f2d6e894878fce6373e4e",
			"name": "Slug",
			"slug": "slug",
			"type": "PlainText",
			"required": true,
			"editable": true,
			"unique": true,
			"validations": {
				"maxLength": 256,
				"pattern": {},
				"messages": {
					"pattern": "Must be alphanumerical and not contain any spaces or special characters",
					"maxLength": "Must be less than 256 characters"
				}
			}
		},
		{
			"id": "924a90e06131260ec1b4cde3fe04c78b",
			"name": "Archived",
			"slug": "_archived",
			"type": "Bool",
			"required": true,
			"editable": true,
			"default": false
		},
		{
			"id": "e0de891b154790b2b5a7887c96e69673",
			"name": "Draft",
			"slug": "_draft",
			"type": "Bool",
			"required": true,
			"editable": true,
			"default": false
		},
		{
			"id": "d005eb440992807385b5527d7ac3df43",
			"name": "Created On",
			"slug": "created-on",
			"type": "Date",
			"required": false,
			"editable": false
		},
		{
			"id": "885952f7145ef136f1e33ee5718a203d",
			"name": "Updated On",
			"slug": "updated-on",
			"type": "Date",
			"required": false,
			"editable": false
		},
		{
			"id": "54fb5afe9258d9d7eb4e7d105ad4ecf4",
			"name": "Published On",
			"slug": "published-on",
			"type": "Date",
			"required": false,
			"editable": false
		},
		{
			"id": "42426a9a2fae38908c0f24785fd947ee",
			"name": "Created By",
			"slug": "created-by",
			"type": "User",
			"required": false,
			"editable": false
		},
		{
			"id": "cb36015872421ae965b88d77ce3bbdaa",
			"name": "Updated By",
			"slug": "updated-by",
			"type": "User",
			"required": false,
			"editable": false
		},
		{
			"id": "a2741c16493270db634b2b6122dd8ebe",
			"name": "Published By",
			"slug": "published-by",
			"type": "User",
			"required": false,
			"editable": false
		}
	]
}

StripeDetails

Properties

Field	Type	Description
`refundReason`	string	Stripe customer ID, or null.
`refundId`	string	Stripe charge ID, or null.
`disputeId`	string	Stripe dispute ID, or null.
`chargeId`	string	Stripe refund ID, or null.
`customerId`	string

Example

{
	"refundReason": null,
	"refundId": null,
	"disputeId": null,
	"chargeId": "ch_1DdPYQKMjGA7k9mI2AKiBY6u",
	"customerId": "cus_E5ajeiWNHEtcAW"
}

StripeCard

Properties

Field	Type	Description
`last4`	string	The last 4 digits on the card.
`brand`	string	The card’s brand.
`ownerName`	string	The name on the card.
`expires`	object	The card’s expiration date.

Example

{
	"last4": "4242",
	"brand": "Visa",
	"ownerName": "Customerio Namen",
	"expires": {
		"year": 2023,
		"month": 12
	}
}

OrderAmount

Properties

Field	Type	Description
`unit`	string
`value`	string
`string`	string

Example

OrderAddress

Properties

Field	Type	Description
`type`	string
`addressee`	string
`line1`	string
`line2`	string
`city`	string
`state`	string
`country`	string
`postalCode`	string

Example

{
	"type": "billing",
	"addressee": "Customerio Namen",
	"line1": "123 Example Rd",
	"line2": "",
	"city": "Examplesville",
	"state": "CA",
	"country": "US",
	"postalCode": "90012"
}

OrderCustomerInfo

Properties

Field	Type	Description
`fullName`	string
`email`	string

Example

{
	"fullName": "Customerio Namen",
	"email": "[email protected]"
}

OrderDownloadedFile

Properties

Field	Type	Description
`id`	string
`name`	string
`url`	string

Example

{
	"id": "5e9a5eba75e0ac242e1b6f64",
	"name": "The modern web design process - Webflow Ebook.pdf",
	"url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa"
}

OrderItemImage

Properties

Field	Type	Description
`fileId`	string
`url`	string

Example

{
	"fileId": "5bfedb42bab0ad90fa7dad2e",
	"url": "https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png"
}

OrderPurchasedItem

Properties

Field	Type	Description
`count`	number	Number of item purchased.
`rowTotal`	OrderAmount	An instance of the OrderAmount object.
`productId`	string	String Product Id.
`productName`	string	Name of the product.
`productSlug`	string	Slug of the product.
`variantId`	string	String Variant Id. (SKU)
`variantName`	string	Name of the variant. (SKU)
`variantSlug`	string	Slug of the variant. (SKU)
`variantImage`	OrderItemImage	An instance of the OrderItemImage object.
`variantPrice`	OrderAmount	An instance of the OrderAmount object.
`height`	number	The height of the variant if provided, 0 otherwise.
`length`	number	The length of the variant if provided, 0 otherwise.
`width`	number	The width of the variant if provided, 0 otherwise
`weight`	number	The weight of the variant if provided, 0 otherwise.
`purchasedItemsCount`	number	The sum of all 'count' fields in 'purchasedItems'.

Example

{
	"count": 1,
	"rowTotal": {
		"unit": "USD",
		"value": 5500,
		"string": "$55.00"
	},
	"productId": "5eb9fd05caef491eb9757183",
	"productName": "White Cup",
	"productSlug": "white-cup",
	"variantId": "5eb9fcace279761d8199790c",
	"variantName": "white-cup_default_sku",
	"variantSlug": "white-cup-default-sku",
	"variantImage": {
		"fileId": "5bfedb42bab0ad90fa7dad2e",
		"url": "https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png"
	},
	"variantPrice": {
		"unit": "USD",
		"value": 5500,
		"string": "$55.00"
	},
	"height": 7,
	"length": 2,
	"weight": 5,
	"width": 4
}

OrderExtra

Properties

Field	Type	Description
`type`	string	The type of extra item this is.
`name`	string	A human-readable (but English) name for this extra charge.
`description`	string	A human-readable (but English) description of this extra charge.
`price`	OrderAmount	An instance of the OrderAmount object.

Example

{
	"type": "tax",
	"name": "State Taxes",
	"description": "CA Taxes (6.25%)",
	"price": {
		"unit": "USD",
		"value": 344,
		"string": "$3.44"
	}
}

OrderTotals

Properties

Field	Type	Description
`subtotal`	OrderAmount	An instance of the OrderAmount object.
`extras`	[OrderExtra]	An array of extra items, includes discounts, shipping, and taxes.
`total`	OrderAmount	An instance of the OrderAmount object.

Example

{
	"subtotal": {
		"unit": "USD",
		"value": 5500,
		"string": "$55.00"
	}
}

Order

Properties

Field	Type	Description
`orderId`	string	The order id. Will usually be 6 hex characters, but can also be 9 hex characters if the site has a very large number of orders. Randomly assigned.

`status`	string	One of `pending`, `unfulfilled`, `fulfilled`, `disputed`, `dispute-lost`, or `refunded`

`comment`	string	A comment string for this order editable by API user (not used by Webflow).
`orderComment`	string	A comment that the customer left when making their order
`acceptedOn`	string	The ISO8601 timestamp that an order was placed.
`disputedOn`	string	If an order was disputed by the customer, then this key will be set with the ISO8601 timestamp that Stripe notifies Webflow. Null if not disputed.

`disputeUpdatedOn`	string	If an order was disputed by the customer, then this key will be set with the ISO8601 timestamp of the last time that we got an update. Null if not disputed.

`disputeLastStatus`	string	If an order was disputed by the customer, then this key will be set with the dispute's status.

`fulfilledOn`	string	If an order was marked as 'fulfilled', then this is the ISO8601 timestamp when that happened.

`refundedOn`	string	If an order was refunded, this is the ISO8601 of when that happened.
`customerPaid`	OrderAmount	An instance of the OrderAmount object.
`netAmount`	OrderAmount	An instance of the OrderAmount object.
`requiresShipping`	boolean	A boolean indicating whether the order contains one or more purchased items that require shipping.

`shippingProvider`	string	A string editable by the API user to note the shipping provider used (not used by Webflow).

`shippingTracking`	string	A string editable by the API user to note the shipping tracking number for the order (not used by Webflow).

`customerInfo`	OrderCustomerInfo	An instance of the OrderCustomerInfo object.
`allAddresses`	[OrderAddress]	All addresses provided by the customer during the ordering flow.
`shippingAddress`	OrderAddress	An instance of the OrderAddress object.
`billingAddress`	OrderAddress	An instance of the OrderAddress object.
`purchasedItems`	[OrderPurchasedItem]	An array of all things that the customer purchased.
`stripeDetails`	StripeDetails	An instance of the StripeDetails object.
`stripeCard`	StripeCard	An instance of the StripeCard object.
`totals`	OrderTotals	An instance of the OrderTotals object.
`customData`	[object]	An array of additional inputs for custom order data gathering. Each object in the array represents an input with a name, and a textInput, textArea, or checkbox value.

`downloadFiles`	[OrderDownloadedFile]	An array of downloadable file objects.

Example

{
	"orderId": "dfa-3f1",
	"status": "unfulfilled",
	"comment": "",
	"orderComment": "",
	"acceptedOn": "2018-12-03T22:06:15.761Z",
	"disputedOn": null,
	"disputeUpdatedOn": null,
	"disputeLastStatus": null,
	"fulfilledOn": null,
	"refundedOn": null,
	"customerPaid": {
		"unit": "USD",
		"value": 6099,
		"string": "$60.99"
	},
	"netAmount": {
		"unit": "USD",
		"value": 5892,
		"string": "$58.92"
	},
	"requiresShipping": true,
	"shippingProvider": null,
	"shippingTracking": null,
	"customerInfo": {
		"fullName": "Customerio Namen",
		"email": "[email protected]"
	},
	"allAddresses": [
		{
			"type": "billing",
			"addressee": "Customerio Namen",
			"line1": "123 Example Rd",
			"line2": "",
			"city": "Examplesville",
			"state": "CA",
			"country": "US",
			"postalCode": "90012"
		},
		{
			"type": "shipping",
			"addressee": "Customerio Namen",
			"line1": "123 Example Rd",
			"line2": "",
			"city": "Examplesville",
			"state": "CA",
			"country": "US",
			"postalCode": "90012"
		}
	],
	"shippingAddress": {
		"type": "shipping",
		"addressee": "Customerio Namen",
		"line1": "123 Example Rd",
		"line2": "",
		"city": "Examplesville",
		"state": "CA",
		"country": "US",
		"postalCode": "90012"
	},
	"billingAddress": {
		"type": "billing",
		"addressee": "Customerio Namen",
		"line1": "123 Example Rd",
		"line2": "",
		"city": "Examplesville",
		"state": "CA",
		"country": "US",
		"postalCode": "90012"
	},
	"purchasedItems": [
		{
			"count": 1,
			"rowTotal": {
				"unit": "USD",
				"value": 5500,
				"string": "$55.00"
			},
			"productId": "5eb9fd05caef491eb9757183",
			"productName": "White Cup",
			"productSlug": "white-cup",
			"variantId": "5eb9fcace279761d8199790c",
			"variantName": "white-cup_default_sku",
			"variantSlug": "white-cup-default-sku",
			"variantImage": {
				"fileId": "5bfedb42bab0ad90fa7dad2e",
				"url": "https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png"
			},
			"variantPrice": {
				"unit": "USD",
				"value": 5500,
				"string": "$55.00"
			},
			"height": 7,
			"length": 2,
			"weight": 5,
			"width": 4
		}
	],
	"purchasedItemsCount": 1,
	"stripeDetails": {
		"refundReason": null,
		"refundId": null,
		"disputeId": null,
		"chargeId": "ch_1DdPYQKMjGA7k9mI2AKiBY6u",
		"customerId": "cus_E5ajeiWNHEtcAW"
	},
	"stripeCard": {
		"last4": "4242",
		"brand": "Visa",
		"ownerName": "Customerio Namen",
		"expires": {
			"year": 2023,
			"month": 12
		}
	},
	"totals": {
		"subtotal": {
			"unit": "USD",
			"value": 5500,
			"string": "$55.00"
		},
		"extras": [
			{
				"type": "tax",
				"name": "State Taxes",
				"description": "CA Taxes (6.25%)",
				"price": {
					"unit": "USD",
					"value": 344,
					"string": "$3.44"
				}
			},
			{
				"type": "tax",
				"name": "County Taxes",
				"description": "LOS ANGELES Taxes (1.00%)",
				"price": {
					"unit": "USD",
					"value": 55,
					"string": "$0.55"
				}
			},
			{
				"type": "tax",
				"name": "Special District Taxes",
				"description": "Special District Taxes (2.25%)",
				"price": {
					"unit": "USD",
					"value": 124,
					"string": "$1.24"
				}
			},
			{
				"type": "shipping",
				"name": "Flat Rate",
				"description": "",
				"price": {
					"unit": "USD",
					"value": 599,
					"string": "$5.99"
				}
			},
			{
				"type": "discount",
				"name": "Discount (SAVE5)",
				"description": "",
				"price": {
					"unit": "USD",
					"value": -500,
					"string": "-$ 5.00 USD"
				}
			}
		],
		"total": {
			"unit": "USD",
			"value": 6122,
			"string": "$61.22"
		}
	},
	"customData": [
		{
			"textInput": "(415) 123-4567",
			"name": "Telephone"
		},
		{
			"textArea": "Happy birthday Mom!",
			"name": "Gift note"
		},
		{
			"checkbox": true,
			"name": "Send as gift"
		}
	],
	"downloadFiles": [
		{
			"id": "5e9a5eba75e0ac242e1b6f64",
			"name": "The modern web design process - Webflow Ebook.pdf",
			"url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa"
		},
		{
			"id": "5e9a5eba75e0ac242e1b6f63",
			"name": "The freelance web designers guide - Webflow Ebook.pdf",
			"url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5dd44c493543b37d5449b3cd;5e9a5eba75e0ac242e1b6f63:ka2nehxy:6af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079"
		}
	]
}

InventoryItem

Properties

Field	Type	Description
`_id`	string	Unique identifier for a SKU item
`quantity`	number	Total quantity of items remaining in inventory (if finite)
`inventoryType`	string	infinite or finite

Example

{
	"_id": "5bfedb42bab0ad90fa7dad39",
	"quantity": 83,
	"inventoryType": "finite"
}

EcommerceSettings

Properties

Field	Type	Description
`createdOn`	string	Date that the site was created on
`site`	string	The id of the site being queried
`defaultCurrency`	string	The three-letter currency code of the site

Example

{
	"createdOn": "2019-02-21T18:41:47.312Z",
	"site": "62f3b1f7eafbc45d0c64ef93",
	"defaultCurrency": "USD"
}

Webhook

Properties

Field	Type	Description
`_id`	string	Unique identifier for a Webhook
`triggerType`	TriggerType	An instance of the TriggerType object.
`triggerId`	string	Unique identifier for the Webhook Trigger
`site`	string	Unique identifier for a Webhook
`filter`	object	filter for selecting which events you want webhooks to be triggered for.
`lastUsed`	string	Date trigger was last used
`createdOn`	string	Date trigger was created

Example

{
	"_id": "582266e0cd48de0f0e3c6d8b",
	"triggerType": "form_submission",
	"triggerId": "562ac0395358780a1f5e6fbd",
	"site": "562ac0395358780a1f5e6fbd",
	"createdOn": "2016-11-08T23:59:28.572Z"
}

TriggerType

Properties

Value	Description
`form_submission`	Sends the form_submission event
`site_publish`	Sends a site_publish event
`ecomm_new_order`	Sends the new ecomm_new_order event
`ecomm_order_changed`	Sends the ecomm_order_changed event
`ecomm_inventory_changed`	Sends the ecomm_inventory_changed event
`memberships_user_account_added`	Sends the memberships_user_account_added event
`memberships_user_account_updated`	Sends the memberships_user_account_updated event
`collection_item_created`	Sends the collection_item_created event
`collection_item_changed`	Sends the collection_item_changed event
`collection_item_deleted`	Sends the collection_item_deleted event
`collection_item_unpublished`	Sends the collection_item_unpublished event

SitePublish

Properties

Field	Type	Description
`site`	string	The site id that was published
`publishTime`	string	The timestamp of the publish event
`domains`	[string]	The domains that were published
`publishedBy`	object	The name and id of the user who published the site

Example

{
	"site": "62749158efef318abc8d5a0f",
	"publishTime": 1653619272801,
	"domains": [
		"my-website.webflow.io"
	],
	"publishedBy": {
		"name": "Some One",
		"id": "123460a7b6c16def4527122d"
	}
}

FormSubmission

Properties

Field	Type	Description
`name`	string	The name of the form
`site`	string	The id of the site that the form was submitted from
`data`	object	The data submitted in the form
`d`	string	The timestamp the form was submitted
`_id`	string	The id of the form submission

Example

{
	"name": "Sample Form",
	"site": "62749158efef318abc8d5a0f",
	"data": {
		"name": "Some One",
		"email": "[email protected]"
	},
	"d": "2022-09-14T12:35:16.117Z",
	"_id": "6321ca84df3949bfc6752327"
}

CollectionItemRemoved

Properties

Field	Type	Description
`deleted`	number	The number of items deleted
`itemId`	string	The id of the collection item that was deleted

Example

{
	"deleted": 1,
	"itemId": "6321ca84df3949bfc6752327"
}

Error

Properties

Field	Type	Description
`code`	number	HTTP error code
`msg`	string	Error message
`name`	string	Name of error
`path`	string	Path of request resulting in error
`err`	string	Full error string
`problems`	[string]	Array of errors (commonly on ValidationErrors)

Example

{
	"msg": "Cannot access resource",
	"code": 401,
	"name": "Unauthorized",
	"path": "/sites/invalid_site",
	"err": "Unauthorized: Cannot access resource"
}

DeleteResult

Properties

Field	Type	Description
`deleted`	number	Number of records deleted

Example

{
	"deleted": 1
}