Skip to main content

Configure delivery options for providers

You can configure delivery options separately for each provider. This includes:

  • Enabling home delivery and pickup point delivery.
  • Setting information for both delivery types.
note

You can perform all these actions in the Delivery Gateway Admin Dashboard.

Enable the provider​

Your customers can only select a specific provider if it is enabled. To enable the provider, use the updateProviderConfigurations mutation and set the AVAILABLE key to true:

GraphQL mutation
mutation {
    updateProviderConfigurations(
        input: [{
          provider: BEST_PROV,
          key: AVAILABLE,
          value: "true",
        },]
    ) {
        key
        value
    }
}

Enable delivery types​

Enabling a given delivery type means that customers can select it when placing an order. You need to enable delivery options for each provider.

Use the updateProviderConfigurations mutation. Its input field takes an array of objects that each need a provider ID, a key, and a value.

  • For home delivery, the key is HOME_DELIVERY_AVAILABLE.
  • For pickup point delivery, the key is PICKUP_POINT_AVAILABLE.

To enable both:

GraphQL mutation
mutation {
    updateProviderConfigurations(
        input: [{
          provider: BEST_PROV,
          key: HOME_DELIVERY_AVAILABLE,
          value: "true",
        },
        {
          provider: BEST_PROV,
          key: PICKUP_POINT_AVAILABLE,
          value: "true"
        }]
    ) {
        key
        value
    }
}

Set delivery information​

Delivery information is additional text that is shown on the Delivery Gateway embedded UI when selecting a provider. You can specify different information for home delivery and pickup point delivery.

Use the updateProviderConfigurations mutation. Its input field takes an array of objects that each need a provider ID, a key, and a value.

  • For home delivery information, the key is HOME_DELIVERY_INFORMATION.
  • For pickup point delivery information, the key is PICKUP_POINT_INFORMATION.
GraphQL mutation
mutation {
    updateProviderConfigurations(
        input: [{
          provider: BEST_PROV,
          key: HOME_DELIVERY_INFORMATION,
          value: "24 hour availability!",
        },
        {
          provider: BEST_PROV,
          key: PICKUP_POINT_INFORMATION,
          value: "We have over 1500 locations"
        }]
    ) {
        key
        value
    }
}