PUB/SUB system is a publication/subscription system that API Users can subscribe to and get notifications on updated resources.
Users can provide a URI per route that can handle the resource provided by the published route. Once a route is modified, a resource to the modified route will be published to User’s corresponding URI.
Users can subscribe to all available published routes by e-mailing a URI per publication.
Current available routes are:
– Job status routes
– Conformation tool URI
Published resources have the following format:
Job Status Routes:
JSON
[
{"source_job_id":"Z3126529173-001","job_name":"Sample Order 1","resource":"https://api.4over.com/orders/Z3126529173-001/status"},
{"source_job_id":"Z2762329119-001","job_name":"Sample Order 2","resource":"https://api.4over.com/orders/Z2762329119-001/status"}
]
Product Routes :
Whenever there is an update to the product, it sends the updated product data to the customer’s listener API endpoint based on their chosen subscription frequency: daily, weekly, or monthly.
Example Payload that will be sent to subscriber endpoint:
JSON
[
{
"product_uuid": "3485feeb-37b0-4f72-b3e7-37ada20dc247",
"product_code": "16PT-PFSLK-6X9",
"product_description": "6\" X 9\" 16PT Silk Laminated Presentation Folder",
"full_product_path": "https:\/\/dev-api.4over.com\/printproducts\/products\/3485feeb-37b0-4f72-b3e7-37ada20dc247",
"categories": "https:\/\/dev-api.4over.com\/printproducts\/products\/3485feeb-37b0-4f72-b3e7-37ada20dc247\/categories",
"product_option_groups": "https:\/\/dev-api.4over.com\/printproducts\/products\/3485feeb-37b0-4f72-b3e7-37ada20dc247\/optiongroups",
"product_base_prices": "https:\/\/dev-api.4over.com\/printproducts\/products\/3485feeb-37b0-4f72-b3e7-37ada20dc247\/baseprices",
"last_updated_at": "2024-06-13 04:33:55.79333-07"
},
{
"product_uuid": "f3ac2bbf-16c3-4fd4-96d7-346aa83c2626",
"product_code": "WHBOPP-ROLB-1X1",
"product_description": "1\" x 1\" White BOPP Roll Label",
"full_product_path": "https:\/\/dev-api.4over.com\/printproducts\/products\/f3ac2bbf-16c3-4fd4-96d7-346aa83c2626",
"categories": "https:\/\/dev-api.4over.com\/printproducts\/products\/f3ac2bbf-16c3-4fd4-96d7-346aa83c2626\/categories",
"product_option_groups": "https:\/\/dev-api.4over.com\/printproducts\/products\/f3ac2bbf-16c3-4fd4-96d7-346aa83c2626\/optiongroups",
"product_base_prices": "https:\/\/dev-api.4over.com\/printproducts\/products\/f3ac2bbf-16c3-4fd4-96d7-346aa83c2626\/baseprices",
"last_updated_at": "2024-06-13 13:38:53.641697-07"
}
]
Products feed Routes :
Example Payload that will be sent to subscriber endpoint:
JSON
{
"entities": [
{
"full_product_path": "https://dev-api.4over.com/printproducts/products/c2552661-c1e4-45e5-985e-f4b0146af3b4",
"product_uuid": "c2552661-c1e4-45e5-985e-f4b0146af3b4",
"product_code": "4CORO-AFRAMERIGID-24X36",
"product_description": "24X36 - 4mm Coroplast Sidewalk Sign",
"categories_path": "https://dev-api.4over.com/printproducts/products/c2552661-c1e4-45e5-985e-f4b0146af3b4/categories",
"categories": [
{
"category_uuid": "900a16a6-7836-4546-b8c5-3b1678c0287e",
"category_name": "Sidewalk Signs",
"category_description": "Sidewalk Signs"
}
],
"product_option_groups_path": "https://dev-api.4over.com/printproducts/products/c2552661-c1e4-45e5-985e-f4b0146af3b4/optiongroups",
"product_option_groups": [
{
"product_option_group_uuid": "34f407f8-0b50-4227-9378-10fddefbe596",
"product_option_group_name": "Size",
"minoccurs": "1",
"maxoccurs": "1",
"validator": null,
"options": [
{
"option_uuid": "821d62bd-54c0-4880-b742-ed26e7b39a85",
"option_name": "24\" x 36\"",
"option_description": null,
"capi_name": "24\" x 36\"",
"capi_description": "24\" x 36\"",
"option_prices": "https://dev-api.4over.com/printproducts/products/c2552661-c1e4-45e5-985e-f4b0146af3b4/optiongroups/34f407f8-0b50-4227-9378-10fddefbe596/options/821d62bd-54c0-4880-b742-ed26e7b39a85/prices",
"option_prices_list": []
}
]
},
{
"product_option_group_uuid": "88c28e92-7c8c-4c05-9908-dcd495e0957a",
"product_option_group_name": "Product Orientation",
"minoccurs": "1",
"maxoccurs": "1",
"validator": null,
"options": [
{
"option_uuid": "991b850a-6643-48d3-afa6-bcda4cf58c85",
"option_name": "Vertical",
"option_description": "Vertical",
"capi_name": "Vertical",
"capi_description": "Vertical",
"option_prices": "https://dev-api.4over.com/printproducts/products/c2552661-c1e4-45e5-985e-f4b0146af3b4/optiongroups/88c28e92-7c8c-4c05-9908-dcd495e0957a/options/991b850a-6643-48d3-afa6-bcda4cf58c85/prices",
"option_prices_list": []
}
]
},
{
"product_option_group_uuid": "24865ffa-793d-43ea-b3b1-d1b5cf22268d",
"product_option_group_name": "Stock",
"minoccurs": "1",
"maxoccurs": "1",
"validator": null,
"options": [
{
"option_uuid": "abb05c41-c43a-4e33-9469-b84184082483",
"option_name": "4mm White Coroplast",
"option_description": "Stock",
"capi_name": "4mm White Coroplast",
"capi_description": "4mm White Coroplast",
"option_prices": "https://dev-api.4over.com/printproducts/products/c2552661-c1e4-45e5-985e-f4b0146af3b4/optiongroups/24865ffa-793d-43ea-b3b1-d1b5cf22268d/options/abb05c41-c43a-4e33-9469-b84184082483/prices",
"option_prices_list": [
{
"option_price_uuid": "e53adc1d-705c-414b-924e-2d4b73337843",
"option_name": "4mm White Coroplast",
"startqty": 1,
"endqty": 100000,
"price": "0",
"price_per_qty": "0",
"is_flat_fee": true,
"qty": 0,
"is_percentage": false
}
]
}
]
},
{
"product_option_group_uuid": "26ca0df3-0682-4f37-8979-409868e2df2d",
"product_option_group_name": "Coating",
"minoccurs": "1",
"maxoccurs": "1",
"validator": null,
"options": [
{
"option_uuid": "3e7618de-abca-4bda-9f97-8b9129e913d8",
"option_name": "No Coating",
"option_description": "UNCOATED",
"capi_name": "No Coating",
"capi_description": "UNCOATED",
"option_prices": "https://dev-api.4over.com/printproducts/products/c2552661-c1e4-45e5-985e-f4b0146af3b4/optiongroups/26ca0df3-0682-4f37-8979-409868e2df2d/options/3e7618de-abca-4bda-9f97-8b9129e913d8/prices",
"option_prices_list": [
{
"option_price_uuid": "a62b386c-31c9-4d19-8a6f-af1fdb75a98a",
"option_name": "No Coating",
"startqty": 1,
"endqty": 100000,
"price": "0",
"price_per_qty": "0",
"is_flat_fee": true,
"qty": 0,
"is_percentage": false
}
]
}
]
},
{
"product_option_group_uuid": "38d33954-5a42-4112-a905-215eb827e62c",
"product_option_group_name": "Colorspec",
"minoccurs": "1",
"maxoccurs": "1",
"validator": null,
"options": [
{
"option_uuid": "32d3c223-f82c-492b-b915-ba065a00862f",
"option_name": "4/0 (4 color front)",
"option_description": "4 Color Front",
"capi_name": "4/0 (4 color front)",
"capi_description": "4/0 (4 color front)",
"option_prices": "https://dev-api.4over.com/printproducts/products/c2552661-c1e4-45e5-985e-f4b0146af3b4/optiongroups/38d33954-5a42-4112-a905-215eb827e62c/options/32d3c223-f82c-492b-b915-ba065a00862f/prices",
"option_prices_list": [
{
"option_price_uuid": "f95c9cc8-dbfc-416a-8411-8957acc66fad",
"option_name": "4/0 (4 color front)",
"startqty": 1,
"endqty": 100000,
"price": "0",
"price_per_qty": "0",
"is_flat_fee": true,
"qty": 0,
"is_percentage": false
}
]
},
{
"option_uuid": "13abbda7-1d64-4f25-8bb2-c179b224825d",
"option_name": "4/4 (4 color both sides)",
"option_description": "",
"capi_name": "4/4 (4 color both sides)",
"capi_description": "4/4 (4 color both sides)",
"option_prices": "https://dev-api.4over.com/printproducts/products/c2552661-c1e4-45e5-985e-f4b0146af3b4/optiongroups/38d33954-5a42-4112-a905-215eb827e62c/options/13abbda7-1d64-4f25-8bb2-c179b224825d/prices",
"option_prices_list": []
}
]
},
{
"product_option_group_uuid": "d7296d0d-7aa2-43f2-97fa-3ac394c8bfd5",
"product_option_group_name": "Hardware",
"minoccurs": "1",
"maxoccurs": "1",
"validator": null,
"options": [
{
"option_uuid": "242c40f8-8bb7-4797-b473-e7650bde25c2",
"option_name": "Signicade Deluxe Plastic Frame - White",
"option_description": "Plasticade Hardware",
"capi_name": "Signicade Deluxe Plastic Frame - White",
"capi_description": "Signicade Deluxe Plastic Frame - White",
"option_prices": "https://dev-api.4over.com/printproducts/products/c2552661-c1e4-45e5-985e-f4b0146af3b4/optiongroups/d7296d0d-7aa2-43f2-97fa-3ac394c8bfd5/options/242c40f8-8bb7-4797-b473-e7650bde25c2/prices",
"option_prices_list": [
{
"option_price_uuid": "000e9ec3-2489-4d91-9d60-8131af65aca0",
"option_name": "Signicade Deluxe Plastic Frame - White",
"startqty": 1,
"endqty": 100,
"price": "0",
"price_per_qty": "0",
"is_flat_fee": true,
"qty": 0,
"is_percentage": false
}
]
}
]
}
],
"last_updated_at": "2024-08-22 08:25:34.249738-07"
}
],
"totalResults": 1,
"currentPage": 0,
"maximumPages": 20
}