locationsAvailableForDeliveryProfiles - admin-graphql - QUERY

Version: 2024-04

Description:

Returns a list of all origin locations available for a delivery profile.

Access Scopes

Arguments

Returns

  • activatable: Boolean! Whether the location can be reactivated. If `false`, then trying to activate the location with the [`LocationActivate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationActivate) mutation will return an error that describes why the location can't be activated.
  • address: LocationAddress! The address of this location.
  • addressVerified: Boolean! Whether the location address has been verified.
  • createdAt: DateTime! The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was added to a shop.
  • deactivatable: Boolean! Whether this location can be deactivated. If `true`, then the location can be deactivated by calling the [`LocationDeactivate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationDeactivate) mutation. If `false`, then calling the mutation to deactivate it will return an error that describes why the location can't be deactivated.
  • deactivatedAt: String The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was deactivated at. For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as `"2019-09-07T15:50:00Z`".
  • deletable: Boolean! Whether this location can be deleted.
  • fulfillmentService: FulfillmentService Name of the service provider that fulfills from this location.
  • fulfillsOnlineOrders: Boolean! Whether this location can fulfill online orders.
  • hasActiveInventory: Boolean! Whether this location has active inventory.
  • hasUnfulfilledOrders: Boolean! Whether this location has orders that need to be fulfilled.
  • id: ID! A globally-unique ID.
  • inventoryLevel: InventoryLevel The quantities of an inventory item at this location.
  • isActive: Boolean! Whether the location is active. A deactivated location can be activated (change `isActive: true`) if it has `activatable` set to `true` by calling the [`locationActivate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationActivate) mutation.
  • isFulfillmentService: Boolean! Whether this location is a fulfillment service.
  • isPrimary: Boolean! Whether the location is your primary location for shipping inventory.
  • legacyResourceId: UnsignedInt64! The ID of the corresponding resource in the REST Admin API.
  • localPickupSettingsV2: DeliveryLocalPickupSettings Local pickup settings for the location.
  • metafield: Metafield A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
  • name: String! The name of the location.
  • privateMetafield: PrivateMetafield Returns a private metafield by namespace and key that belongs to the resource.
  • shipsInventory: Boolean! Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
  • suggestedAddresses: LocationSuggestedAddress! List of suggested addresses for this location (empty if none).
  • updatedAt: DateTime! The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the location was last updated.

Examples