{"id":33953158,"url":"https://github.com/mageworx/module-deliverydate-graph-ql","last_synced_at":"2026-05-27T18:30:59.828Z","repository":{"id":57703113,"uuid":"498844570","full_name":"mageworx/module-deliverydate-graph-ql","owner":"mageworx","description":"GraphQL Addon for MageWorx Delivery Date Extension","archived":false,"fork":false,"pushed_at":"2025-05-13T16:39:50.000Z","size":27,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-12-14T08:49:57.140Z","etag":null,"topics":["magento2-delivery-date","magento2-extension","magento2-graphql","magento2-module","magento2-plugin"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mageworx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-06-01T18:00:24.000Z","updated_at":"2025-10-15T05:11:07.000Z","dependencies_parsed_at":"2022-09-26T21:11:32.221Z","dependency_job_id":null,"html_url":"https://github.com/mageworx/module-deliverydate-graph-ql","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/mageworx/module-deliverydate-graph-ql","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mageworx%2Fmodule-deliverydate-graph-ql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mageworx%2Fmodule-deliverydate-graph-ql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mageworx%2Fmodule-deliverydate-graph-ql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mageworx%2Fmodule-deliverydate-graph-ql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mageworx","download_url":"https://codeload.github.com/mageworx/module-deliverydate-graph-ql/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mageworx%2Fmodule-deliverydate-graph-ql/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33579665,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-27T02:00:06.184Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["magento2-delivery-date","magento2-extension","magento2-graphql","magento2-module","magento2-plugin"],"created_at":"2025-12-12T19:57:12.307Z","updated_at":"2026-05-27T18:30:59.811Z","avatar_url":"https://github.com/mageworx.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MageWorx_DeliveryDateGraphQl\n\nGraphQL API module for Mageworx [Magento 2 Delivery Date](https://www.mageworx.com/delivery-date-magento-2.html) extension.\n\n## Installation\n\n**1) Installation using composer (from packagist)**\n- Execute the following command: `composer require mageworx/module-deliverydate-graph-ql`\n\n**2) Copy-to-paste method**\n- Download this module and upload it to the `app/code/MageWorx/DeliveryDateGraphQl` directory *(create \"DeliveryDateGraphQl\" first if missing)*\n\n## How to use\n\n### 1. The **deliveryDate** query returns the information about the selected Delivery Date of the specified cart.\n\nQuery attribute is defined below:\n\n```\ncart_id: String! - The unique ID of the cart to query.\n```\n\nBy default you can use the following attributes:\n\n```\nday: String     - Delivery day, like 2022-05-11\ntime: String    - Delivery time, like 00:00_23:59\ncomment: String - Delivery comment given by a customer\n```\n\n**Request:**\n\n```graphql\nquery ($magentoCartId: String!) {\n    deliveryDate(cart_id: $magentoCartId) {\n        day\n        time\n        comment\n    }\n}\n```\n\n**Response:**\n\n```json\n{\n    \"data\": {\n        \"deliveryDate\": {\n            \"day\": \"2022-05-11\",\n            \"time\": \"14:00_16:00\",\n            \"comment\": \"Hello GraphQL\"\n        }\n    }\n}\n```\n---\n\u003e ***Note***\n\u003e\n\u003e We are using next variables in our examples:\n\u003e\n\u003e ```json\n\u003e {\n\u003e     \"magentoCartId\": \"{{graphQLCartId}}\"\n\u003e }\n\u003e ```\n\u003e\n\u003e where `{{graphQLCartId}}` is string like `VVEmRZMaLRgH1NZ7kkZXWJKIfZiIhbvP` (masked quote id).\n---\n\n### 2. The **availableDeliveryDates** query returns the information about the all available delivery dates (with time) for the cart.\n\nQuery attribute is defined below:\n\n```\ncart_id: String!        - The unique ID of the cart to query.\nmethod: String          - Shipping method code in carriercode_methodcode format. Returns the result for all methods if not specified.\nstart_day_index: Int    - Offset of days from which the calculation starts. Returns the result from tooday if not specified.\nend_day_index: Int      - Number of days to calculate. Returns the result till \"Max Delivery Period\" if not specified (could be different per Delivery Option configuration).\n```\n\nBy default you can use the following attributes:\n\n```\nmethod: String                  - Shipping method code in carriercode_methodcode format.\nday_limits: [DeliveryDayLimit]  - List of available limits for that method and cart\n```\n\nDeliveryDayLimit object:\n\n```\nday_index: Int                      - Index of the day from today (from 0).\ndate_formatted: String              - Date formatted using format selected in store configuration.\ndate: String                        - Date in standard Y-m-d format.\nextra_charge: ExtraCharge           - Extra charge for that day.\ntime_limits: [DeliveryTimeLimit]    - Limits by time when available.\n```\n\nDeliveryTimeLimit object:\n\n```\nfrom: String              - Time from in hh:mm format.\nto: String                - Time to in hh:mm format.\nextra_charge: ExtraCharge - Extra charge for that time slot. Summed up with a surcharge from the delivery day settings.\n```\n\nExtraCharge object:\n\n```\namount: Float           - Amount in selected currency (in cart currency).\nformatted: String       - Formatted according selected locale (with currency symbol).\ncurrency_symbol: String - Currency symbol.\ncurrency_code: String   - Currency code.\n```\n\n**Request:**\n\n```graphql\nquery ($magentoCartId: String!) {\n    availableDeliveryDates(\n        cart_id: $magentoCartId\n        method: \"flatrate_flatrate\"\n        start_day_index: 2\n        end_day_index: 10\n    ) {\n        method,\n        day_limits {\n            day_index\n            date_formatted\n            date\n            extra_charge {\n                amount\n                formatted\n                currency_code\n                currency_symbol\n            }\n            time_limits {\n                from\n                to\n                extra_charge {\n                    amount\n                    formatted\n                    currency_code\n                    currency_symbol\n                }\n            }\n        }\n    }\n}\n```\n\n**Response:**\n\n```json\n{\n  \"data\": {\n    \"availableDeliveryDates\": [\n      {\n        \"method\": \"flatrate_flatrate\",\n        \"day_limits\": [\n          {\n            \"day_index\": 5,\n            \"date_formatted\": \"14-June-2023\",\n            \"date\": \"2023-06-14\",\n            \"extra_charge\": null,\n            \"time_limits\": [\n              {\n                \"from\": \"09:00\",\n                \"to\": \"12:00\",\n                \"extra_charge\": {\n                  \"amount\": 0,\n                  \"formatted\": \"\",\n                  \"currency_code\": \"EUR\",\n                  \"currency_symbol\": \"€\"\n                }\n              },\n              {\n                \"from\": \"11:00\",\n                \"to\": \"16:00\",\n                \"extra_charge\": {\n                  \"amount\": 0,\n                  \"formatted\": \"\",\n                  \"currency_code\": \"EUR\",\n                  \"currency_symbol\": \"€\"\n                }\n              },\n              {\n                \"from\": \"15:00\",\n                \"to\": \"20:00\",\n                \"extra_charge\": {\n                  \"amount\": 4.5409,\n                  \"formatted\": \"€4.54\",\n                  \"currency_code\": \"EUR\",\n                  \"currency_symbol\": \"€\"\n                }\n              }\n            ]\n          },\n          {\n            \"day_index\": 6,\n            \"date_formatted\": \"15-June-2023\",\n            \"date\": \"2023-06-15\",\n            \"extra_charge\": null,\n            \"time_limits\": [\n              {\n                \"from\": \"09:00\",\n                \"to\": \"12:00\",\n                \"extra_charge\": {\n                  \"amount\": 0,\n                  \"formatted\": \"\",\n                  \"currency_code\": \"EUR\",\n                  \"currency_symbol\": \"€\"\n                }\n              },\n              {\n                \"from\": \"11:00\",\n                \"to\": \"16:00\",\n                \"extra_charge\": {\n                  \"amount\": 0,\n                  \"formatted\": \"\",\n                  \"currency_code\": \"EUR\",\n                  \"currency_symbol\": \"€\"\n                }\n              },\n              {\n                \"from\": \"15:00\",\n                \"to\": \"20:00\",\n                \"extra_charge\": {\n                  \"amount\": 4.5409,\n                  \"formatted\": \"€4.54\",\n                  \"currency_code\": \"EUR\",\n                  \"currency_symbol\": \"€\"\n                }\n              }\n            ]\n          }\n        ]\n      }\n    ]\n  }\n}\n```\n\n### 3. The **setDeliveryDateOnCart** mutation allows you to set delivery date and time to the cart.\n\nSyntax:\n```\nmutation: {setDeliveryDateOnCart(input: SetDeliveryDateOnCartInput): Cart}\n```\n\nThe SetDeliveryDateOnCartInput object must contain the following attributes:\n```\ncart_id: String!                    - The unique ID of a `Cart` object.\ndelivery_date: DeliveryDateInput!   - Selected delivery date, time (optional) and comment (optional).\n```\n\nThe DeliveryDateInput object must contain the following attributes:\n```\nday: String!    - A string that identifies a delivery day in standard format Y-m-d.\ntime: String    - A string that identifies a delivery time diapason in \"12:00_23:59\" fromat. Must be a valid time.\ncomment: String - Comment for delivery. Any additional information from customer. Visible to customer by default.\n```\n\n**Request:**\n\n```graphql\nmutation ($magentoCartId: String!) {\n    setDeliveryDateOnCart(\n        input: {\n            cart_id: $magentoCartId,\n            delivery_date: {\n                day: \"2022-05-11\"\n                time: \"14:00_16:00\"\n                comment: \"Hello GraphQL\"\n            }\n        }\n    ) {\n        delivery_date {\n            day\n            time\n            comment\n        }\n    }\n}\n```\n\n**Response:**\n\n```json\n{\n    \"data\": {\n        \"setDeliveryDateOnCart\": {\n            \"delivery_date\": {\n                \"day\": \"2022-05-11\",\n                \"time\": \"14:00_16:00\",\n                \"comment\": \"Hello GraphQL\"\n            }\n        }\n    }\n}\n```\n\n### 4. The **removeDeliveryDateFromCart** mutation allows you to remove selected delivery date and time from the cart (if exists).\n\nSyntax:\n```\nmutation: {removeDeliveryDateFromCart(cart_id: String!): Cart}\n```\n\n**Request:**\n\n```graphql\nmutation ($magentoCartId: String!) {\n    removeDeliveryDateFromCart (cart_id: $magentoCartId) {\n        delivery_date {\n            day\n            time\n            comment\n        }\n    }\n}\n```\n\n**Response:**\n\n```json\n{\n    \"data\": {\n        \"removeDeliveryDateFromCart\": {\n            \"delivery_date\": {\n                \"day\": \"\",\n                \"time\": \"\",\n                \"comment\": \"\"\n            }\n        }\n    }\n}\n```\n\n### 5. The **delivery_date** object is also available in the Cart type.\n\nBy default you can use the following attributes:\n\n```\nday: String     - Delivery day, like 2022-05-11\ntime: String    - Delivery time, like 00:00_23:59\ncomment: String - Delivery comment given by a customer\n```\n\n**Request**\n\n```graphql\n{\n  customerCart {\n    id\n    items {\n      id\n      product {\n        name\n        sku\n      }\n      quantity\n    }\n    delivery_date {\n        day \n        time\n        comment\n    }\n  }\n}\n```\n\n**Response**\n\n```json\n{\n    \"data\": {\n        \"customerCart\": {\n            \"id\": \"VVEmRZMaLRgH1NZ7kkZXWJKIfZiIhbvP\",\n            \"items\": [\n                {\n                    \"id\": \"37\",\n                    \"product\": {\n                        \"name\": \"A\",\n                        \"sku\": \"A\"\n                    },\n                    \"quantity\": 1\n                }\n            ],\n            \"delivery_date\": {\n                \"day\": \"2022-05-11\",\n                \"time\": \"14:00_16:00\",\n                \"comment\": \"Hello GraphQL\"\n            }\n        }\n    }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmageworx%2Fmodule-deliverydate-graph-ql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmageworx%2Fmodule-deliverydate-graph-ql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmageworx%2Fmodule-deliverydate-graph-ql/lists"}