Item Update

This webhook is triggered whenever any items are altered on your account.

A JSON, XML, or x-www-form-urlencoded object containing the following export fields can be found in directly in the raw body of the POST request to your server:

Item

Field

Type

Description

unit

string

The allocation type for the item.

sku

string

The item’s SKU

url

string

The Item’s “More Info URL”

lock

integer

If the item has Date Based Inventory control active.

0 means that Date-based inventory is disabled.

visibility

string

The visibility of this item on the booking page.

  • * for Everyone

  • S for Staff

  • P for Packages Only

name

string

The name of the item.

pos

integer

The sort order integer.

meta

object

Contains meta details for the item. This changes based on the add-ons and data for the item.

stock

integer

The item’s inventory.

unlimited

integer

This returns if the item’s inventory is unlimited or not.

0 means the inventory is limited.

video

object

See item.video below.

image

object

See item.image below.

category_id

integer

The id of the category this item is in.

rated

integer

If this item is simple or not.

0 means the item is simple.

product_group_type

string

The type of item this is in a Product Group.

P is for Parent, C is child.

product_group_children

object

Contains the Item object of the items that are children of the main item.

type

string

Determines if this is an Item or a Gift Certificate.

status

string

This is the availability status for the item.

alias_id

integer

The ID of the item this is aliased too. This will not show the ID of items aliased to this item.

len

integer

The fixed length of the item.

rules

object

Contains the item’s parameters, fixed length, and attribute specific rules such as default length start time, etc.

category

string

The name of the category this item is in.

item.video

Field

Type

Description

id

string

This is the identifying string for the Youtube URL.

start

integer

How many seconds into the video to start.

item.image

Field

Type

Description

#

integer

The index of the image. The images are numbered in the order they were uploaded, but are organized in the order they are displayed on the item.

item.image.images

Field

Type

Description

src

string

The identifying string for the image.

path

string

The identifying path to where the image is found relative to your Checkfront Account URL.

url

string
The identifying path to where a full sized version

image is found on the server.

url_medium

string

The identifying path to where a medium version of the image is found on the server.

url_small

string

The identifying path to where a small version of the image is found on the server.

Sample Item Update Notification

JSON

 1{
 2    "version": "3.28.0.7",
 3    "host": "your-company.checkfront.com",
 4    "type": "item",
 5    "action": "update",
 6    "item": {
 7        "unit": "30M",
 8        "item_id": "40",
 9        "url": "",
10        "lock": 1,
11        "visibility": "*",
12        "name": "Test Item",
13        "pos": 0,
14        "summary": "",
15        "details": "",
16        "meta": "{\"display_mode\":\"dropdown\",\"Xero_item_account\":\"0\",\"item_package_rate\":\"\",\"delay\":0}",
17        "stock": 5,
18        "unlimited": 0,
19        "video": {
20            "id": "",
21            "start": 0
22        },
23        "image": [],
24        "category_id": 9,
25        "rated": 0,
26        "product_group_type": "P",
27        "product_group_children": [
28            {
29                "item_id": "41",
30                "sku": "test-item_copy",
31                "stock": "1",
32                "name": "Test Item Additional Session",
33                "category_id": "9",
34                "price": "{\"0\":{\"participant\":\"5.00\"}}",
35                "price_type": "U",
36                "summary": "",
37                "url": "",
38                "img": "",
39                "meta": "{\"display_mode\":\"dropdown\",\"item_package_rate\":\"\",\"delay\":0}",
40                "enabled": "1",
41                "status": "A",
42                "unlimited": "0",
43                "alias_id": "40",
44                "lock": "1",
45                "package": "{\"61\":{\"optin\":\"O\"}}",
46                "rated": "1",
47                "visible": "1",
48                "visibility": "*",
49                "taxes": "",
50                "video": "{\"id\":\"\",\"start\":0}",
51                "rules": "{\"param\":{\"inventorycontro\":{\"MIN\":\"0\",\"MAX\":\"0\"},\"participant\":{\"MIN\":\"1\",\"MAX\":\"10\"}},\"fixed\":{\"start_time\":\"\"}}",
52                "unit": "30M",
53                "len": "0",
54                "param": "{\"inventorycontro\":1,\"participant\":1}",
55                "ecom": "1",
56                "gprice": "{}",
57                "type": "I",
58                "price_fixed": "0.00",
59                "pos": "0",
60                "location": null,
61                "details": "",
62                "extra_details": "",
63                "commission_type": "P",
64                "commission_amount": null,
65                "product_group_type": "C",
66                "product_group_children": ""
67            }
68        ],
69        "type": "I",
70        "status": "A",
71        "alias_id": 0,
72        "len": 0,
73        "rules": "{\"param\":{\"inventorycontro\":{\"MIN\":\"4\",\"MAX\":\"4\"},\"participant\":{\"MIN\":\"1\",\"MAX\":\"10\"}},\"fixed\":{\"start_time\":\"\"}}",
74        "category": "Programming"
75    }
76}

XML

 1<?xml version="1.0" encoding="utf-8"?>
 2<checkfront-notify version="3.29.0.1" host="your-company.checkfront.com">
 3    <type>item</type>
 4    <action>update</action>
 5    <item>
 6        <unit>30M</unit>
 7        <item_id>40</item_id>
 8        <sku>test-item</sku>
 9        <url></url>
10        <lock>1</lock>
11        <visibility>*</visibility>
12        <name>Test Item</name>
13        <pos>0</pos>
14        <summary></summary>
15        <details></details>
16        <meta>{"display_mode":"dropdown","Xero_item_account":"0","item_package_rate":"","delay":0}</meta>
17        <stock>5</stock>
18        <unlimited>0</unlimited>
19        <video>
20            <id></id>
21            <start>0</start>
22        </video>
23        <image/>
24        <category_id>9</category_id>
25        <rated>0</rated>
26        <product_group_type>P</product_group_type>
27        <product_group_children>
28            <item_id>41</item_id>
29            <sku>test-item_copy</sku>
30            <stock>1</stock>
31            <name>Test Item Additional Session</name>
32            <category_id>9</category_id>
33            <price>{"0":{"participant":"5.00"}}</price>
34            <price_type>U</price_type>
35            <summary></summary>
36            <url></url>
37            <img></img>
38            <meta>{"display_mode":"dropdown","item_package_rate":"","delay":0}</meta>
39            <enabled>1</enabled>
40            <status>A</status>
41            <unlimited>0</unlimited>
42            <alias_id>40</alias_id>
43            <lock>1</lock>
44            <package>{"61":{"optin":"O"}}</package>
45            <rated>1</rated>
46            <visible>1</visible>
47            <visibility>*</visibility>
48            <taxes></taxes>
49            <video>{"id":"","start":0}</video>
50            <rules>{"param":{"inventorycontro":{"MIN":"0","MAX":"0"},"participant":{"MIN":"1","MAX":"10"}},"fixed":{"start_time":""}}</rules>
51            <unit>30M</unit>
52            <len>0</len>
53            <param>{"inventorycontro":1,"participant":1}</param>
54            <ecom>1</ecom>
55            <gprice>{}</gprice>
56            <type>I</type>
57            <price_fixed>0.00</price_fixed>
58            <pos>0</pos>
59            <location/>
60            <details></details>
61            <extra_details></extra_details>
62            <commission_type>P</commission_type>
63            <commission_amount/>
64            <product_group_type>C</product_group_type>
65            <product_group_children></product_group_children>
66            <category/>
67        </product_group_children>
68        <type>I</type>
69        <status>A</status>
70        <alias_id>0</alias_id>
71        <len>0</len>
72        <rules>{"param":{"inventorycontro":{"MIN":"4","MAX":"4"},"participant":{"MIN":"1","MAX":"10"}},"fixed":{"start_time":""}}</rules>
73        <category>Programming</category>
74    </item>
75</checkfront-notify>