Choose a version:

ShippingConfiguration

interface

Requires Any of shipping access scopes or manage_delivery_settings user permission.

Compatibility interface for market shipping configurations. Implemented by DeliveryMarketProfile during the GraphQL rename rollout.

Anchor to FieldsFields

Anchor to activeOptionDefinitionsCountactiveOptionDefinitionsCount

•Count!

non-null

The number of active shipping option definitions in this configuration.

Anchor to isEnabledisEnabled

•Boolean!

non-null

Whether shipping is enabled for this market. When false, customers in this market won't see any shipping options.

Anchor to optionDefinitionsoptionDefinitions

•DeliveryOptionDefinitionConnection!

non-null

The option definitions for this market's shipping configuration.

Anchor to activeactive •Boolean: Filter option definitions by active state. When true, returns only active option definitions; when false, returns only inactive option definitions; when omitted or null, returns all option definitions.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Deprecated fields

Anchor to idid •ID! non-nullDeprecated
Anchor to optionDefinitionsCountoptionDefinitionsCount •Count! non-nullDeprecated

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to DeliveryMarketProfile DeliveryMarketProfile

•OBJECT

The shipping configuration attached to a market. Defines the shipping options available when a buyer is resolved to that market.

Anchor to activeOptionDefinitionsCountactiveOptionDefinitionsCount

•Count!

non-null

The number of active shipping options in this configuration.

Anchor to isEnabledisEnabled

•Boolean!

non-null

Whether shipping is enabled for this market. When false, customers in this market won't see any shipping options.

Anchor to optionDefinitionsoptionDefinitions

•DeliveryOptionDefinitionConnection!

non-null

The shipping options configured for this market.

Anchor to activeactive •Boolean: Filter shipping options by active state. When true, returns only active shipping options; when false, returns only inactive shipping options; when omitted or null, returns all shipping options.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to idid

•ID!

non-nullDeprecated

Anchor to optionDefinitionsCountoptionDefinitionsCount

•Count!

non-nullDeprecated

Was this section helpful?

{

"activeOptionDefinitionsCount": "",

"id": "",

"isEnabled": "",

"optionDefinitions": {

"active": "",

"after": "",

"before": "",

"first": "",

"last": "",

"reverse": ""

"optionDefinitionsCount": ""

}

Variables

{
	"activeOptionDefinitionsCount": "",
	"id": "",
	"isEnabled": "",
	"optionDefinitions": {
		"active": "",
		"after": "",
		"before": "",
		"first": "",
		"last": "",
		"reverse": ""
	},
	"optionDefinitionsCount": ""
}

Schema

interface ShippingConfiguration {
  activeOptionDefinitionsCount: Count!
  id: ID!
  isEnabled: Boolean!
  optionDefinitions: DeliveryOptionDefinitionConnection!
  optionDefinitionsCount: Count!
}

ShippingConfiguration

Anchor to FieldsFields

Arguments

Deprecated fields

Anchor to Types implemented inTypes implemented in

Arguments