PUB\/SUB system is a publication\/subscription system that API Users can subscribe to and get notifications on updated resources.
\nUsers 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.
\nUsers can subscribe to all available published routes by e-mailing a URI per publication.<\/p>\n
Current available routes are:<\/p>\n
– Job status routes<\/p>\n
– Conformation tool URI<\/p>\n
Published resources have the following format:<\/p>\n
Job Status Routes:<\/p>\n
JSON<\/p>\n
\n[\n {"source_job_id":"Z3126529173-001","job_name":"Sample Order 1","resource":"https:\/\/api.4over.com\/orders\/Z3126529173-001\/status"},\n {"source_job_id":"Z2762329119-001","job_name":"Sample Order 2","resource":"https:\/\/api.4over.com\/orders\/Z2762329119-001\/status"}\n]\n<\/pre>\nProduct Routes :<\/p>\n
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.<\/p>\n
Example Payload that will be sent to subscriber endpoint:<\/p>\n
JSON<\/p>\n
\n[\n {\n "product_uuid": "3485feeb-37b0-4f72-b3e7-37ada20dc247",\n "product_code": "16PT-PFSLK-6X9",\n "product_description": "6\\" X 9\\" 16PT Silk Laminated Presentation Folder",\n "full_product_path": "https:\\\/\\\/dev-api.4over.com\\\/printproducts\\\/products\\\/3485feeb-37b0-4f72-b3e7-37ada20dc247",\n "categories": "https:\\\/\\\/dev-api.4over.com\\\/printproducts\\\/products\\\/3485feeb-37b0-4f72-b3e7-37ada20dc247\\\/categories",\n "product_option_groups": "https:\\\/\\\/dev-api.4over.com\\\/printproducts\\\/products\\\/3485feeb-37b0-4f72-b3e7-37ada20dc247\\\/optiongroups",\n "product_base_prices": "https:\\\/\\\/dev-api.4over.com\\\/printproducts\\\/products\\\/3485feeb-37b0-4f72-b3e7-37ada20dc247\\\/baseprices",\n "last_updated_at": "2024-06-13 04:33:55.79333-07"\n },\n {\n "product_uuid": "f3ac2bbf-16c3-4fd4-96d7-346aa83c2626",\n "product_code": "WHBOPP-ROLB-1X1",\n "product_description": "1\\" x 1\\" White BOPP Roll Label",\n "full_product_path": "https:\\\/\\\/dev-api.4over.com\\\/printproducts\\\/products\\\/f3ac2bbf-16c3-4fd4-96d7-346aa83c2626",\n "categories": "https:\\\/\\\/dev-api.4over.com\\\/printproducts\\\/products\\\/f3ac2bbf-16c3-4fd4-96d7-346aa83c2626\\\/categories",\n "product_option_groups": "https:\\\/\\\/dev-api.4over.com\\\/printproducts\\\/products\\\/f3ac2bbf-16c3-4fd4-96d7-346aa83c2626\\\/optiongroups",\n "product_base_prices": "https:\\\/\\\/dev-api.4over.com\\\/printproducts\\\/products\\\/f3ac2bbf-16c3-4fd4-96d7-346aa83c2626\\\/baseprices",\n "last_updated_at": "2024-06-13 13:38:53.641697-07"\n }\n]\n<\/pre>\nProducts feed Routes :<\/p>\n
Example Payload that will be sent to subscriber endpoint:<\/p>\n
JSON<\/p>\n
\n{\n "entities": [\n {\n "full_product_path": "https:\/\/dev-api.4over.com\/printproducts\/products\/c2552661-c1e4-45e5-985e-f4b0146af3b4",\n "product_uuid": "c2552661-c1e4-45e5-985e-f4b0146af3b4",\n "product_code": "4CORO-AFRAMERIGID-24X36",\n "product_description": "24X36 - 4mm Coroplast Sidewalk Sign",\n "categories_path": "https:\/\/dev-api.4over.com\/printproducts\/products\/c2552661-c1e4-45e5-985e-f4b0146af3b4\/categories",\n "categories": [\n {\n "category_uuid": "900a16a6-7836-4546-b8c5-3b1678c0287e",\n "category_name": "Sidewalk Signs",\n "category_description": "Sidewalk Signs"\n }\n ],\n "product_option_groups_path": "https:\/\/dev-api.4over.com\/printproducts\/products\/c2552661-c1e4-45e5-985e-f4b0146af3b4\/optiongroups",\n "product_option_groups": [\n {\n "product_option_group_uuid": "34f407f8-0b50-4227-9378-10fddefbe596",\n "product_option_group_name": "Size",\n "minoccurs": "1",\n "maxoccurs": "1",\n "validator": null,\n "options": [\n {\n "option_uuid": "821d62bd-54c0-4880-b742-ed26e7b39a85",\n "option_name": "24\\" x 36\\"",\n "option_description": null,\n "capi_name": "24\\" x 36\\"",\n "capi_description": "24\\" x 36\\"",\n "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",\n "option_prices_list": []\n }\n ]\n },\n {\n "product_option_group_uuid": "88c28e92-7c8c-4c05-9908-dcd495e0957a",\n "product_option_group_name": "Product Orientation",\n "minoccurs": "1",\n "maxoccurs": "1",\n "validator": null,\n "options": [\n {\n "option_uuid": "991b850a-6643-48d3-afa6-bcda4cf58c85",\n "option_name": "Vertical",\n "option_description": "Vertical",\n "capi_name": "Vertical",\n "capi_description": "Vertical",\n "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",\n "option_prices_list": []\n }\n ]\n },\n {\n "product_option_group_uuid": "24865ffa-793d-43ea-b3b1-d1b5cf22268d",\n "product_option_group_name": "Stock",\n "minoccurs": "1",\n "maxoccurs": "1",\n "validator": null,\n "options": [\n {\n "option_uuid": "abb05c41-c43a-4e33-9469-b84184082483",\n "option_name": "4mm White Coroplast",\n "option_description": "Stock",\n "capi_name": "4mm White Coroplast",\n "capi_description": "4mm White Coroplast",\n "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",\n "option_prices_list": [\n {\n "option_price_uuid": "e53adc1d-705c-414b-924e-2d4b73337843",\n "option_name": "4mm White Coroplast",\n "startqty": 1,\n "endqty": 100000,\n "price": "0",\n "price_per_qty": "0",\n "is_flat_fee": true,\n "qty": 0,\n "is_percentage": false\n }\n ]\n }\n ]\n },\n {\n "product_option_group_uuid": "26ca0df3-0682-4f37-8979-409868e2df2d",\n "product_option_group_name": "Coating",\n "minoccurs": "1",\n "maxoccurs": "1",\n "validator": null,\n "options": [\n {\n "option_uuid": "3e7618de-abca-4bda-9f97-8b9129e913d8",\n "option_name": "No Coating",\n "option_description": "UNCOATED",\n "capi_name": "No Coating",\n "capi_description": "UNCOATED",\n "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",\n "option_prices_list": [\n {\n "option_price_uuid": "a62b386c-31c9-4d19-8a6f-af1fdb75a98a",\n "option_name": "No Coating",\n "startqty": 1,\n "endqty": 100000,\n "price": "0",\n "price_per_qty": "0",\n "is_flat_fee": true,\n "qty": 0,\n "is_percentage": false\n }\n ]\n }\n ]\n },\n {\n "product_option_group_uuid": "38d33954-5a42-4112-a905-215eb827e62c",\n "product_option_group_name": "Colorspec",\n "minoccurs": "1",\n "maxoccurs": "1",\n "validator": null,\n "options": [\n {\n "option_uuid": "32d3c223-f82c-492b-b915-ba065a00862f",\n "option_name": "4\/0 (4 color front)",\n "option_description": "4 Color Front",\n "capi_name": "4\/0 (4 color front)",\n "capi_description": "4\/0 (4 color front)",\n "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",\n "option_prices_list": [\n {\n "option_price_uuid": "f95c9cc8-dbfc-416a-8411-8957acc66fad",\n "option_name": "4\/0 (4 color front)",\n "startqty": 1,\n "endqty": 100000,\n "price": "0",\n "price_per_qty": "0",\n "is_flat_fee": true,\n "qty": 0,\n "is_percentage": false\n }\n ]\n },\n {\n "option_uuid": "13abbda7-1d64-4f25-8bb2-c179b224825d",\n "option_name": "4\/4 (4 color both sides)",\n "option_description": "",\n "capi_name": "4\/4 (4 color both sides)",\n "capi_description": "4\/4 (4 color both sides)",\n "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",\n "option_prices_list": []\n }\n ]\n },\n {\n "product_option_group_uuid": "d7296d0d-7aa2-43f2-97fa-3ac394c8bfd5",\n "product_option_group_name": "Hardware",\n "minoccurs": "1",\n "maxoccurs": "1",\n "validator": null,\n "options": [\n {\n "option_uuid": "242c40f8-8bb7-4797-b473-e7650bde25c2",\n "option_name": "Signicade Deluxe Plastic Frame - White",\n "option_description": "Plasticade Hardware",\n "capi_name": "Signicade Deluxe Plastic Frame - White",\n "capi_description": "Signicade Deluxe Plastic Frame - White",\n "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",\n "option_prices_list": [\n {\n "option_price_uuid": "000e9ec3-2489-4d91-9d60-8131af65aca0",\n "option_name": "Signicade Deluxe Plastic Frame - White",\n "startqty": 1,\n "endqty": 100,\n "price": "0",\n "price_per_qty": "0",\n "is_flat_fee": true,\n "qty": 0,\n "is_percentage": false\n }\n ]\n }\n ]\n }\n ],\n "last_updated_at": "2024-08-22 08:25:34.249738-07"\n }\n ],\n "totalResults": 1,\n "currentPage": 0,\n "maximumPages": 20\n}\n<\/pre>\n","protected":false},"excerpt":{"rendered":"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 […]<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":0,"menu_order":11,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-139","page","type-page","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/pages\/139","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/api-users.4over.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=139"}],"version-history":[{"count":22,"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/pages\/139\/revisions"}],"predecessor-version":[{"id":850,"href":"https:\/\/api-users.4over.com\/index.php?rest_route=\/wp\/v2\/pages\/139\/revisions\/850"}],"wp:attachment":[{"href":"https:\/\/api-users.4over.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=139"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}