PHPackages                             mageworx/module-deliverydate-graph-ql - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. mageworx/module-deliverydate-graph-ql

ActiveMagento2-module[API Development](/categories/api)

mageworx/module-deliverydate-graph-ql
=====================================

Graph QL Addon for MageWorx Delivery Date Extension

1.3.0(12mo ago)13981[1 issues](https://github.com/mageworx/module-deliverydate-graph-ql/issues)OSL-3.0PHP

Since Jun 7Pushed 12mo ago4 watchersCompare

[ Source](https://github.com/mageworx/module-deliverydate-graph-ql)[ Packagist](https://packagist.org/packages/mageworx/module-deliverydate-graph-ql)[ RSS](/packages/mageworx-module-deliverydate-graph-ql/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (3)Versions (8)Used By (0)

MageWorx\_DeliveryDateGraphQl
=============================

[](#mageworx_deliverydategraphql)

GraphQL API module for Mageworx [Magento 2 Delivery Date](https://www.mageworx.com/delivery-date-magento-2.html) extension.

Installation
------------

[](#installation)

**1) Installation using composer (from packagist)**

- Execute the following command: `composer require mageworx/module-deliverydate-graph-ql`

**2) Copy-to-paste method**

- Download this module and upload it to the `app/code/MageWorx/DeliveryDateGraphQl` directory *(create "DeliveryDateGraphQl" first if missing)*

How to use
----------

[](#how-to-use)

### 1. The **deliveryDate** query returns the information about the selected Delivery Date of the specified cart.

[](#1-the-deliverydate-query-returns-the-information-about-the-selected-delivery-date-of-the-specified-cart)

Query attribute is defined below:

```
cart_id: String! - The unique ID of the cart to query.

```

By default you can use the following attributes:

```
day: String     - Delivery day, like 2022-05-11
time: String    - Delivery time, like 00:00_23:59
comment: String - Delivery comment given by a customer

```

**Request:**

```
query ($magentoCartId: String!) {
    deliveryDate(cart_id: $magentoCartId) {
        day
        time
        comment
    }
}
```

**Response:**

```
{
    "data": {
        "deliveryDate": {
            "day": "2022-05-11",
            "time": "14:00_16:00",
            "comment": "Hello GraphQL"
        }
    }
}
```

---

> ***Note***
>
> We are using next variables in our examples:
>
> ```
> {
>     "magentoCartId": "{{graphQLCartId}}"
> }
> ```
>
>
>
> where `{{graphQLCartId}}` is string like `VVEmRZMaLRgH1NZ7kkZXWJKIfZiIhbvP` (masked quote id).

---

### 2. The **availableDeliveryDates** query returns the information about the all available delivery dates (with time) for the cart.

[](#2-the-availabledeliverydates-query-returns-the-information-about-the-all-available-delivery-dates-with-time-for-the-cart)

Query attribute is defined below:

```
cart_id: String!        - The unique ID of the cart to query.
method: String          - Shipping method code in carriercode_methodcode format. Returns the result for all methods if not specified.
start_day_index: Int    - Offset of days from which the calculation starts. Returns the result from tooday if not specified.
end_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).

```

By default you can use the following attributes:

```
method: String                  - Shipping method code in carriercode_methodcode format.
day_limits: [DeliveryDayLimit]  - List of available limits for that method and cart

```

DeliveryDayLimit object:

```
day_index: Int                      - Index of the day from today (from 0).
date_formatted: String              - Date formatted using format selected in store configuration.
date: String                        - Date in standard Y-m-d format.
extra_charge: ExtraCharge           - Extra charge for that day.
time_limits: [DeliveryTimeLimit]    - Limits by time when available.

```

DeliveryTimeLimit object:

```
from: String              - Time from in hh:mm format.
to: String                - Time to in hh:mm format.
extra_charge: ExtraCharge - Extra charge for that time slot. Summed up with a surcharge from the delivery day settings.

```

ExtraCharge object:

```
amount: Float           - Amount in selected currency (in cart currency).
formatted: String       - Formatted according selected locale (with currency symbol).
currency_symbol: String - Currency symbol.
currency_code: String   - Currency code.

```

**Request:**

```
query ($magentoCartId: String!) {
    availableDeliveryDates(
        cart_id: $magentoCartId
        method: "flatrate_flatrate"
        start_day_index: 2
        end_day_index: 10
    ) {
        method,
        day_limits {
            day_index
            date_formatted
            date
            extra_charge {
                amount
                formatted
                currency_code
                currency_symbol
            }
            time_limits {
                from
                to
                extra_charge {
                    amount
                    formatted
                    currency_code
                    currency_symbol
                }
            }
        }
    }
}
```

**Response:**

```
{
  "data": {
    "availableDeliveryDates": [
      {
        "method": "flatrate_flatrate",
        "day_limits": [
          {
            "day_index": 5,
            "date_formatted": "14-June-2023",
            "date": "2023-06-14",
            "extra_charge": null,
            "time_limits": [
              {
                "from": "09:00",
                "to": "12:00",
                "extra_charge": {
                  "amount": 0,
                  "formatted": "",
                  "currency_code": "EUR",
                  "currency_symbol": "€"
                }
              },
              {
                "from": "11:00",
                "to": "16:00",
                "extra_charge": {
                  "amount": 0,
                  "formatted": "",
                  "currency_code": "EUR",
                  "currency_symbol": "€"
                }
              },
              {
                "from": "15:00",
                "to": "20:00",
                "extra_charge": {
                  "amount": 4.5409,
                  "formatted": "€4.54",
                  "currency_code": "EUR",
                  "currency_symbol": "€"
                }
              }
            ]
          },
          {
            "day_index": 6,
            "date_formatted": "15-June-2023",
            "date": "2023-06-15",
            "extra_charge": null,
            "time_limits": [
              {
                "from": "09:00",
                "to": "12:00",
                "extra_charge": {
                  "amount": 0,
                  "formatted": "",
                  "currency_code": "EUR",
                  "currency_symbol": "€"
                }
              },
              {
                "from": "11:00",
                "to": "16:00",
                "extra_charge": {
                  "amount": 0,
                  "formatted": "",
                  "currency_code": "EUR",
                  "currency_symbol": "€"
                }
              },
              {
                "from": "15:00",
                "to": "20:00",
                "extra_charge": {
                  "amount": 4.5409,
                  "formatted": "€4.54",
                  "currency_code": "EUR",
                  "currency_symbol": "€"
                }
              }
            ]
          }
        ]
      }
    ]
  }
}
```

### 3. The **setDeliveryDateOnCart** mutation allows you to set delivery date and time to the cart.

[](#3-the-setdeliverydateoncart-mutation-allows-you-to-set-delivery-date-and-time-to-the-cart)

Syntax:

```
mutation: {setDeliveryDateOnCart(input: SetDeliveryDateOnCartInput): Cart}

```

The SetDeliveryDateOnCartInput object must contain the following attributes:

```
cart_id: String!                    - The unique ID of a `Cart` object.
delivery_date: DeliveryDateInput!   - Selected delivery date, time (optional) and comment (optional).

```

The DeliveryDateInput object must contain the following attributes:

```
day: String!    - A string that identifies a delivery day in standard format Y-m-d.
time: String    - A string that identifies a delivery time diapason in "12:00_23:59" fromat. Must be a valid time.
comment: String - Comment for delivery. Any additional information from customer. Visible to customer by default.

```

**Request:**

```
mutation ($magentoCartId: String!) {
    setDeliveryDateOnCart(
        input: {
            cart_id: $magentoCartId,
            delivery_date: {
                day: "2022-05-11"
                time: "14:00_16:00"
                comment: "Hello GraphQL"
            }
        }
    ) {
        delivery_date {
            day
            time
            comment
        }
    }
}
```

**Response:**

```
{
    "data": {
        "setDeliveryDateOnCart": {
            "delivery_date": {
                "day": "2022-05-11",
                "time": "14:00_16:00",
                "comment": "Hello GraphQL"
            }
        }
    }
}
```

### 4. The **removeDeliveryDateFromCart** mutation allows you to remove selected delivery date and time from the cart (if exists).

[](#4-the-removedeliverydatefromcart-mutation-allows-you-to-remove-selected-delivery-date-and-time-from-the-cart-if-exists)

Syntax:

```
mutation: {removeDeliveryDateFromCart(cart_id: String!): Cart}

```

**Request:**

```
mutation ($magentoCartId: String!) {
    removeDeliveryDateFromCart (cart_id: $magentoCartId) {
        delivery_date {
            day
            time
            comment
        }
    }
}
```

**Response:**

```
{
    "data": {
        "removeDeliveryDateFromCart": {
            "delivery_date": {
                "day": "",
                "time": "",
                "comment": ""
            }
        }
    }
}
```

### 5. The **delivery\_date** object is also available in the Cart type.

[](#5-the-delivery_date-object-is-also-available-in-the-cart-type)

By default you can use the following attributes:

```
day: String     - Delivery day, like 2022-05-11
time: String    - Delivery time, like 00:00_23:59
comment: String - Delivery comment given by a customer

```

**Request**

```
{
  customerCart {
    id
    items {
      id
      product {
        name
        sku
      }
      quantity
    }
    delivery_date {
        day
        time
        comment
    }
  }
}
```

**Response**

```
{
    "data": {
        "customerCart": {
            "id": "VVEmRZMaLRgH1NZ7kkZXWJKIfZiIhbvP",
            "items": [
                {
                    "id": "37",
                    "product": {
                        "name": "A",
                        "sku": "A"
                    },
                    "quantity": 1
                }
            ],
            "delivery_date": {
                "day": "2022-05-11",
                "time": "14:00_16:00",
                "comment": "Hello GraphQL"
            }
        }
    }
}
```

###  Health Score

30

—

LowBetter than 65% of packages

Maintenance30

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~267 days

Total

5

Last Release

361d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/65778a3ac5b8e94197cca381d780c54c1e85c63e21fb9690865e7351655bcdf8?d=identicon)[support@mageworx.com](/maintainers/support@mageworx.com)

---

Top Contributors

[![SiarheyUchukhlebau](https://avatars.githubusercontent.com/u/18072226?v=4)](https://github.com/SiarheyUchukhlebau "SiarheyUchukhlebau (20 commits)")

---

Tags

magento2-delivery-datemagento2-extensionmagento2-graphqlmagento2-modulemagento2-plugin

### Embed Badge

![Health badge](/badges/mageworx-module-deliverydate-graph-ql/health.svg)

```
[![Health](https://phpackages.com/badges/mageworx-module-deliverydate-graph-ql/health.svg)](https://phpackages.com/packages/mageworx-module-deliverydate-graph-ql)
```

###  Alternatives

[smile/elasticsuite

Magento 2 merchandising and search engine built on ElasticSearch

8044.5M33](/packages/smile-elasticsuite)[mollie/magento2

Mollie Payment Module for Magento 2

1121.6M10](/packages/mollie-magento2)[graycore/magento2-cors

A Magento 2 module that enables CORS on the GraphQL and REST Apis

99516.1k](/packages/graycore-magento2-cors)[elgentos/module-prismicio

Magento 2 - Prismic.io integration

39112.0k3](/packages/elgentos-module-prismicio)[zepgram/module-rest

Technical module to industrialize API REST call with dependency injection pattern using Guzzle library

1326.2k](/packages/zepgram-module-rest)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)