Changelog

Stay updated on this page about any additions, changes and deprecations for the API.

The api is currently not versioned and any breaking changes and deprecations will happen with 3 months notice.

We're continually adding new fields which are not considered breaking changes and any external services should make sure any extra fields does not break their integrations.

Additionally we might also make breaking changes or deprications without notice to endpoints that haven't been used for the last 6 months.

When changing critical endpoints we always try to evolve our API in a way that doesn't distrupt your business and integrations more than necessary.

Planned changes

1st September 2020

We are planning to replace IDs with the UUIDs in all API endpoints, as it is our plan to remove IDs completely from Codefort.

We therefore recommend you to use the uuid field as the identifier in your external systems.

To make the change more seamless we are keeping the uuid field after the change, so any systems depending on the UUID don't have to change.

Before change

{
	"data": {
		"id": 1668033007604759,
		"uuid": "fc31866f-7839-414f-9e17-68e58915ff65",
		"handle": "sale",
		...

After change

{
	"data": {
		"id": "fc31866f-7839-414f-9e17-68e58915ff65",
		"uuid": "fc31866f-7839-414f-9e17-68e58915ff65",
		"handle": "sale",
		...

Changes

2th November 2020

We've added expenses API.

30th July 2020

We've added products API.

29th July 2020

We've added metafields to the customer API.

Example

...
	"total_spent": 2000,
	"metafields": [
		{
			"key": "birthday",
			"value": "24-12-1980",
			"type": "string"
		}
	],
	"created_at": "2020-07-27T15:32:27.000000Z",
...

28th July 2020

We've added image and url within line_items to the order API.

Example

...
	"line_items": [
		{
			"id": "59364ee0-a083-4f83-abff-6f42d43db950",
			"variant_id": "99038822-9abd-47ce-a015-0fb4241ccb8d",
			"product_id": "c1d2cd92-4787-4aa9-9277-4438615253d4",
			"title": "Some product",
			"qty": 1,
			"image": "https://betafiles.codefort.io/your-shop/images/products/1024x1024/3bib7ik8c0d55.jpg",
			"price": "https://your-shop.codefort.io/products/some-product?variant=1613771488048544"
		}
	]
...

We've added shop details to the meta data for all API resources and webhooks.

Example

...
	},
	"meta": {
		"shop": {
			"id": "9e1d2172-6843-494f-8jf5-1a9d1duui304",
			"handle": "your-shop",
			"name": "Your Shop"
		}
	}
}

27th June 2020

We've added attributes and line_items to the order API.

Example

...
		"attributes": {
			"timeslot": "10:40"
		},
		"line_items": [
			{
				"id": "59364ee0-a083-4f83-abff-6f42d43db950",
				"variant_id": "99038822-9abd-47ce-a015-0fb4241ccb8d",
				"product_id": "c1d2cd92-4787-4aa9-9277-4438615253d4",
				"title": "Some product",
				"qty": 1,
				"price": 9900
			}
		]
	}
}