How to apply for use of the Cielo API
Please contact Cielo directly
A new feature has been added to the product pricing.
[discount_for_sea_freight] These minus values are subtracted from the [price][Undecorated] pricing
This is a image and text layout, indicating the XML field name to on screen images
Notes
By Default the calls for products are limited = 100.
Max number of Products per call = 250. (This is done by adding a ?limit=250 parmeter to the call)
No limits on Categories
Pagination Notes
To get the next page. You can loop through using the latest date of the provided products and pass into the next new call.
As an example
https://api.cielo.net.au/?token={token}&command=products&updated_on=1900-01-01&sort=updated_at is the first call
The latest date of this one is 2000-01-01 00:00:00
To get the next set of products you would call https://api.cielo.net.au/?token={token}&command=products&updated_on=2000-01-01 00:00:00&sort=updated_at
Below is a download link for both Postman SDK and Sample PHP coding to call the API
How it works:
When triggered, our system will automatically append the type (deleted, created, updated) to the end of the URL you provide. Your system will then respond to the specified action accordingly.
There are three wehooks {type of callback}.
If you are going to use WebHooks, you will need to create the URL on your website and then email the URLs To Cielo to have added in the API system
The URL would be something like this (example): https://yourdomainname.com.au/ceilowebhook/
Our system will handle various types of data associated with your URL (example):
The URL would be something like this (example): https://yourdomainname.com.au/ceilowebhook?type=
Our system will handle various types of data associated with your URL (example):
Invalid token
Invalid command
https://api.cielo.net.au/?command=appaCategories&token={token}
https://api.cielo.net.au/?command=products&posted=Y&appaCategory[]={appaCategory}&token={token}
https://api.cielo.net.au/?command=categories&token={token}
https://api.cielo.net.au/?command=categoriesTree&token={token}
https://api.cielo.net.au/?command=deletedProducts&deleted_on={deleted_on}&token={token}
https://api.cielo.net.au/?command=products&sort=updated_at&updated_on={updated_on}
https://api.cielo.net.au/?command=products&sort=created_at&posted=Y&created_at={created_at}&token={token}
https://api.cielo.net.au/?command=baseproducts&posted=Y&id={entity_id}&sort={entity_id}&token={token}&limit=50
https://api.cielo.net.au/?command=products&posted=Y&category={categoryId}&token={token}
https://api.cielo.net.au/?command=products&sort=entity_id&posted=Y&id={entity_id}&token={token}
| Variable | Description |
|---|---|
| {id} | The last id of which product you have |
[
{
"201": {
"entity_id": "201",
"sku": "G1038",
"updated_at": "2016-10-14 04:32:57",
"categories": [
{
"category_id": "19",
"path": "1/2/19",
"value": "Business"
},
{
"category_id": "51",
"path": "1/2/51",
"value": "Promotion"
},
{
"category_id": "183",
"path": "1/2/51/183",
"value": "Money Banks"
},
{
"category_id": "184",
"path": "1/2/51/183/184",
"value": "Animals"
}
],
"all_children": null,
"available_sort_by": null,
"avatar_src": null,
"avatar_valid": null,
"better_branding_positions": null,
"better_print_method": null,
"body": null,
"branding_position": "1146",
"branding_types": "Pad",
"capacity": null,
"carton_height": "56",
"carton_lentgh": "59",
"carton_l_w_h": "59 x 42 x 56cm",
"carton_qunatity": "40",
"carton_size": "59 x 42 x 56",
"carton_weight": "12",
"carton_width": "42",
"catalogue_notes": null,
"category_ids": null,
"children": null,
"children_count": null,
"city": null,
"color": null,
"company": null,
"confirmation": null,
"cost_one_colour": null,
"cost_other_colour": null,
"country_id": null,
"country_of_manufacture": null,
"created_at": null,
"created_in": null,
"cubic_weight": "138.8",
"custom_apply_to_products": null,
"custom_design": null,
"custom_design_from": null,
"custom_design_to": null,
"custom_layout_update": null,
"custom_use_parent_settings": null,
"decoration_position": null,
"default_billing": null,
"default_configuration_id": null,
"default_shipping": null,
"default_sort_by": null,
"description": "Cute plastic and rubberised screw on nosed piggy bank.
",
"disable_auto_group_change": null,
"display_mode": null,
"dob": null,
"ecataloge": null,
"ecataloge_image": null,
"ecceilo": null,
"eco_friendly": null,
"email": null,
"fax": null,
"featured": "0",
"features": null,
"fgapi_callbackurl": null,
"fgapi_expiry_date": null,
"fgapi_token": null,
"filter_image": null,
"filter_price_range": null,
"firstname": null,
"freight_note": null,
"frieght_multiplier": "1.5",
"future_stock": null,
"gallery": "./G1038-Blue.jpg,./G1038-Pink",
"gender": null,
"gift_message_available": "0",
"group_id": null,
"group_price": null,
"has_options": null,
"homepage_trending": null,
"homepage_trending_order": null,
"image": "/g/1/g1038.jpg",
"image_label": null,
"image_label1": null,
"include_in_menu": null,
"indent_stock": null,
"is_active": null,
"is_anchor": null,
"is_liquid_pixel": "0",
"is_recurring": null,
"landing_page": null,
"lastname": null,
"level": null,
"line_art": "G1038.pdf",
"links_exist": null,
"links_purchased_separately": null,
"links_title": null,
"liquidpixel_chain": null,
"manufacturer": null,
"marketing_sheet": null,
"materials": null,
"media_gallery": null,
"meta_description": null,
"meta_keyword": null,
"meta_keywords": null,
"meta_title": null,
"middlename": null,
"minimal_price": null,
"mix_n_match_folder": null,
"mix_n_match_parts": null,
"msrp": null,
"msrp_display_actual_price_type": "2",
"msrp_enabled": "0",
"name": "Piggy bank",
"navigation_column_side": null,
"navigation_pw_fl_bgcolor": null,
"navigation_pw_fl_iheight": null,
"navigation_pw_fl_ipos": null,
"navigation_pw_fl_iwidth": null,
"navigation_pw_fl_obgcolor": null,
"navigation_pw_fl_otcolor": null,
"navigation_pw_fl_tcolor": null,
"navigation_pw_fl_tsize": null,
"navigation_pw_fl_view": null,
"navigation_pw_gn_shopby": null,
"navigation_pw_m_bcolor": null,
"navigation_pw_m_bgcolor": null,
"navigation_pw_m_bradius": null,
"navigation_pw_m_bsize": null,
"navigation_pw_m_obgcolor": null,
"navigation_pw_m_otcolor": null,
"navigation_pw_m_sccolor": null,
"navigation_pw_m_tcolor": null,
"navigation_pw_ob_bgcolor": null,
"navigation_pw_ob_desc": null,
"navigation_pw_ob_height": null,
"navigation_pw_ob_pos": null,
"navigation_pw_ob_show": null,
"navigation_pw_ob_width": null,
"navigation_pw_side_width": null,
"navigation_pw_sl_iheight": null,
"navigation_pw_sl_ipos": null,
"navigation_pw_sl_iwidth": null,
"navigation_pw_sl_otcolor": null,
"navigation_pw_sl_tcolor": null,
"navigation_pw_sl_tsize": null,
"navigation_pw_sl_view": null,
"navigation_pw_s_bcolor": null,
"navigation_pw_s_bgcolor": null,
"navigation_pw_s_bsize": null,
"navigation_pw_s_column": null,
"navigation_pw_s_cwidth": null,
"navigation_pw_s_c_indentl": null,
"navigation_pw_s_c_indentr": null,
"navigation_pw_s_height": null,
"navigation_pw_s_img": null,
"navigation_pw_s_template": null,
"navigation_pw_s_width": null,
"new": "0",
"news_from_date": null,
"news_to_date": null,
"new_carton_h": null,
"new_carton_kg": null,
"new_carton_l": null,
"new_carton_qty": null,
"new_carton_w": null,
"new_colour": "1321,1331,1327",
"new_pieces": null,
"next_shipment_due_date": null,
"next_shipment_quantity": null,
"old_id": null,
"options_container": "container2",
"other_1": null,
"other_2": null,
"page_layout": null,
"part_number": null,
"password_created_at": null,
"password_hash": null,
"path": null,
"path_in_store": null,
"pen_set": null,
"pick_n_mix": null,
"pieces": "1",
"position": null,
"postcode": null,
"prefix": null,
"price_type": null,
"price_view": null,
"print_method": null,
"print_notes": null,
"print_size": "40 x 20mm
",
"product_features": null,
"product_materials": null,
"product_materials_override": null,
"product_packing": null,
"profit_1000_qty": null,
"profit_100_qty": null,
"profit_250_qty": null,
"profit_500_qty": null,
"profit_50_qty": null,
"profit_method": null,
"profit_setup": null,
"q_100": null,
"q_1000": null,
"q_25": null,
"q_250": null,
"q_2500": null,
"q_2_100": null,
"q_2_1000": null,
"q_2_25": null,
"q_2_250": null,
"q_2_2500": null,
"q_2_50": null,
"q_2_500": null,
"q_3_100": null,
"q_3_1000": null,
"q_3_25": null,
"q_3_250": null,
"q_3_2500": null,
"q_3_50": null,
"q_3_500": null,
"q_4_100": null,
"q_4_1000": null,
"q_4_25": null,
"q_4_250": null,
"q_4_2500": null,
"q_4_50": null,
"q_4_500": null,
"q_50": null,
"q_500": null,
"q_5_100": null,
"q_5_1000": null,
"q_5_25": null,
"q_5_250": null,
"q_5_2500": null,
"q_5_50": null,
"q_5_500": null,
"recurring_profile": null,
"region": null,
"region_id": null,
"required_options": null,
"rp_token": null,
"rp_token_created_at": null,
"samples_title": null,
"shipment_type": null,
"short_description": "Cute plastic and rubberised screw on nosed piggy bank.
",
"size": "200 x 110 x 130mm",
"size_1": null,
"sku_type": null,
"small_image": "/g/1/g1038.jpg",
"small_image_label": null,
"special": "0",
"special_from_date": null,
"special_price": null,
"special_to_date": null,
"starbursts": null,
"status": "2",
"store_id": null,
"street": null,
"suffix": null,
"taxvat": null,
"tax_class_id": "0",
"telephone": null,
"test1": null,
"thumbnail": "/g/1/g1038.jpg",
"thumbnail_label": null,
"tier_price": null,
"trending": null,
"trim": null,
"twist_click": null,
"uom": "Each",
"url_key": "piggy-bank",
"url_path": "piggy-bank.html",
"usb_storage": null,
"value_range": null,
"vat_id": null,
"vat_is_valid": null,
"vat_request_date": null,
"vat_request_id": null,
"vat_request_success": null,
"visibility": "4",
"website_id": null,
"weight": null,
"weight_type": null,
"stock": "0.0000",
"stock_status": "0",
"linked": {
"relation": {
"178": "G1003",
"311": "G1171",
"339": "G1211",
"624": "G1686",
"842": "G772"
},
"up_sell": {
"328": "G1194",
"903": "G970",
"904": "G971"
},
"variants": {
"6175": "G1038-undecorated-blue",
"6176": "G1038-undecorated-pink"
}
}
}
}
]
https://api.cielo.net.au/?command=products&sku={sku}&token={token}
Please note: If you want to return a product with all the variants, remove the posted parameter.
ie: https://api.cielo.net.au/?command=products&sku={sku}&token={token}
As all variants are set to "posted": "N"
https://api.cielo.net.au/?command=products&posted=Y&sku[]={sku1}&sku[]={sku2}&token={token}
| Variable | Description |
|---|---|
| {sku1} | First Sku |
| {sku2} | Second Sku |
[
{
"201": {
"entity_id": "201",
"sku": "G1038",
"updated_at": "2016-10-14 04:32:57",
"categories": [
{
"category_id": "19",
"path": "1/2/19",
"value": "Business"
},
{
"category_id": "51",
"path": "1/2/51",
"value": "Promotion"
},
{
"category_id": "183",
"path": "1/2/51/183",
"value": "Money Banks"
},
{
"category_id": "184",
"path": "1/2/51/183/184",
"value": "Animals"
}
],
"all_children": null,
"available_sort_by": null,
"avatar_src": null,
"avatar_valid": null,
"better_branding_positions": null,
"better_print_method": null,
"body": null,
"branding_position": "1146",
"branding_types": "Pad",
"capacity": null,
"carton_height": "56",
"carton_lentgh": "59",
"carton_l_w_h": "59 x 42 x 56cm",
"carton_qunatity": "40",
"carton_size": "59 x 42 x 56",
"carton_weight": "12",
"carton_width": "42",
"catalogue_notes": null,
"category_ids": null,
"children": null,
"children_count": null,
"city": null,
"color": null,
"company": null,
"confirmation": null,
"cost_one_colour": null,
"cost_other_colour": null,
"country_id": null,
"country_of_manufacture": null,
"created_at": null,
"created_in": null,
"cubic_weight": "138.8",
"custom_apply_to_products": null,
"custom_design": null,
"custom_design_from": null,
"custom_design_to": null,
"custom_layout_update": null,
"custom_use_parent_settings": null,
"decoration_position": null,
"default_billing": null,
"default_configuration_id": null,
"default_shipping": null,
"default_sort_by": null,
"description": "Cute plastic and rubberised screw on nosed piggy bank.
",
"disable_auto_group_change": null,
"display_mode": null,
"dob": null,
"ecataloge": null,
"ecataloge_image": null,
"ecceilo": null,
"eco_friendly": null,
"email": null,
"fax": null,
"featured": "0",
"features": null,
"fgapi_callbackurl": null,
"fgapi_expiry_date": null,
"fgapi_token": null,
"filter_image": null,
"filter_price_range": null,
"firstname": null,
"freight_note": null,
"frieght_multiplier": "1.5",
"future_stock": null,
"gallery": "./G1038-Blue.jpg,./G1038-Pink",
"gender": null,
"gift_message_available": "0",
"group_id": null,
"group_price": null,
"has_options": null,
"homepage_trending": null,
"homepage_trending_order": null,
"image": "/g/1/g1038.jpg",
"image_label": null,
"image_label1": null,
"include_in_menu": null,
"indent_stock": null,
"is_active": null,
"is_anchor": null,
"is_liquid_pixel": "0",
"is_recurring": null,
"landing_page": null,
"lastname": null,
"level": null,
"line_art": "G1038.pdf",
"links_exist": null,
"links_purchased_separately": null,
"links_title": null,
"liquidpixel_chain": null,
"manufacturer": null,
"marketing_sheet": null,
"materials": null,
"media_gallery": null,
"meta_description": null,
"meta_keyword": null,
"meta_keywords": null,
"meta_title": null,
"middlename": null,
"minimal_price": null,
"mix_n_match_folder": null,
"mix_n_match_parts": null,
"msrp": null,
"msrp_display_actual_price_type": "2",
"msrp_enabled": "0",
"name": "Piggy bank",
"navigation_column_side": null,
"navigation_pw_fl_bgcolor": null,
"navigation_pw_fl_iheight": null,
"navigation_pw_fl_ipos": null,
"navigation_pw_fl_iwidth": null,
"navigation_pw_fl_obgcolor": null,
"navigation_pw_fl_otcolor": null,
"navigation_pw_fl_tcolor": null,
"navigation_pw_fl_tsize": null,
"navigation_pw_fl_view": null,
"navigation_pw_gn_shopby": null,
"navigation_pw_m_bcolor": null,
"navigation_pw_m_bgcolor": null,
"navigation_pw_m_bradius": null,
"navigation_pw_m_bsize": null,
"navigation_pw_m_obgcolor": null,
"navigation_pw_m_otcolor": null,
"navigation_pw_m_sccolor": null,
"navigation_pw_m_tcolor": null,
"navigation_pw_ob_bgcolor": null,
"navigation_pw_ob_desc": null,
"navigation_pw_ob_height": null,
"navigation_pw_ob_pos": null,
"navigation_pw_ob_show": null,
"navigation_pw_ob_width": null,
"navigation_pw_side_width": null,
"navigation_pw_sl_iheight": null,
"navigation_pw_sl_ipos": null,
"navigation_pw_sl_iwidth": null,
"navigation_pw_sl_otcolor": null,
"navigation_pw_sl_tcolor": null,
"navigation_pw_sl_tsize": null,
"navigation_pw_sl_view": null,
"navigation_pw_s_bcolor": null,
"navigation_pw_s_bgcolor": null,
"navigation_pw_s_bsize": null,
"navigation_pw_s_column": null,
"navigation_pw_s_cwidth": null,
"navigation_pw_s_c_indentl": null,
"navigation_pw_s_c_indentr": null,
"navigation_pw_s_height": null,
"navigation_pw_s_img": null,
"navigation_pw_s_template": null,
"navigation_pw_s_width": null,
"new": "0",
"news_from_date": null,
"news_to_date": null,
"new_carton_h": null,
"new_carton_kg": null,
"new_carton_l": null,
"new_carton_qty": null,
"new_carton_w": null,
"new_colour": "1321,1331,1327",
"new_pieces": null,
"next_shipment_due_date": null,
"next_shipment_quantity": null,
"old_id": null,
"options_container": "container2",
"other_1": null,
"other_2": null,
"page_layout": null,
"part_number": null,
"password_created_at": null,
"password_hash": null,
"path": null,
"path_in_store": null,
"pen_set": null,
"pick_n_mix": null,
"pieces": "1",
"position": null,
"postcode": null,
"prefix": null,
"price_type": null,
"price_view": null,
"print_method": null,
"print_notes": null,
"print_size": "40 x 20mm
",
"product_features": null,
"product_materials": null,
"product_materials_override": null,
"product_packing": null,
"profit_1000_qty": null,
"profit_100_qty": null,
"profit_250_qty": null,
"profit_500_qty": null,
"profit_50_qty": null,
"profit_method": null,
"profit_setup": null,
"q_100": null,
"q_1000": null,
"q_25": null,
"q_250": null,
"q_2500": null,
"q_2_100": null,
"q_2_1000": null,
"q_2_25": null,
"q_2_250": null,
"q_2_2500": null,
"q_2_50": null,
"q_2_500": null,
"q_3_100": null,
"q_3_1000": null,
"q_3_25": null,
"q_3_250": null,
"q_3_2500": null,
"q_3_50": null,
"q_3_500": null,
"q_4_100": null,
"q_4_1000": null,
"q_4_25": null,
"q_4_250": null,
"q_4_2500": null,
"q_4_50": null,
"q_4_500": null,
"q_50": null,
"q_500": null,
"q_5_100": null,
"q_5_1000": null,
"q_5_25": null,
"q_5_250": null,
"q_5_2500": null,
"q_5_50": null,
"q_5_500": null,
"recurring_profile": null,
"region": null,
"region_id": null,
"required_options": null,
"rp_token": null,
"rp_token_created_at": null,
"samples_title": null,
"shipment_type": null,
"short_description": "Cute plastic and rubberised screw on nosed piggy bank.
",
"size": "200 x 110 x 130mm",
"size_1": null,
"sku_type": null,
"small_image": "/g/1/g1038.jpg",
"small_image_label": null,
"special": "0",
"special_from_date": null,
"special_price": null,
"special_to_date": null,
"starbursts": null,
"status": "2",
"store_id": null,
"street": null,
"suffix": null,
"taxvat": null,
"tax_class_id": "0",
"telephone": null,
"test1": null,
"thumbnail": "/g/1/g1038.jpg",
"thumbnail_label": null,
"tier_price": null,
"trending": null,
"trim": null,
"twist_click": null,
"uom": "Each",
"url_key": "piggy-bank",
"url_path": "piggy-bank.html",
"usb_storage": null,
"value_range": null,
"vat_id": null,
"vat_is_valid": null,
"vat_request_date": null,
"vat_request_id": null,
"vat_request_success": null,
"visibility": "4",
"website_id": null,
"weight": null,
"weight_type": null,
"stock": "0.0000",
"stock_status": "0",
"linked": {
"relation": {
"178": "G1003",
"311": "G1171",
"339": "G1211",
"624": "G1686",
"842": "G772"
},
"up_sell": {
"328": "G1194",
"903": "G970",
"904": "G971"
},
"variants": {
"6175": "G1038-undecorated-blue",
"6176": "G1038-undecorated-pink"
}
}
}
}
]