DeliveryParticipant

Version 2019-07 (Latest)

A carrier-defined rate with possible merchant-defined fixed fee or percentage-of-rate fee.

Required access

read_shipping access scope

Show definition
"""
A carrier-defined rate with possible merchant-defined fixed fee or percentage-of-rate fee.
"""
type DeliveryParticipant implements Node {
  """
  Flag to indicate if new available services should be included.
  """
  adaptToNewServicesFlag: Boolean!
  """
  Use this carrier service for this participant.
  """
  carrierService: DeliveryCarrierService!
  """
  The merchant-set fixed fee for this participant.
  """
  fixedFee: MoneyV2
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Services offered by the participant and their active status.
  """
  participantServices: [DeliveryParticipantService!]!
  """
  The merchant-set percentage-of-rate fee for this participant.
  """
  percentageOfRateFee: Float!
}

Implements

Fields

adaptToNewServicesFlag (Boolean!)

Flag to indicate if new available services should be included.

carrierService (DeliveryCarrierService!)

Use this carrier service for this participant.

fixedFee (MoneyV2)

The merchant-set fixed fee for this participant.

id (ID!)

Globally unique identifier.

participantServices ([DeliveryParticipantService!]!)

Services offered by the participant and their active status.

percentageOfRateFee (Float!)

The merchant-set percentage-of-rate fee for this participant.

Version 2019-10 (Release candidate)

A carrier-defined rate with possible merchant-defined fixed fee or percentage-of-rate fee.

Required access

read_shipping access scope

Show definition
"""
A carrier-defined rate with possible merchant-defined fixed fee or percentage-of-rate fee.
"""
type DeliveryParticipant implements Node {
  """
  Flag to indicate if new available services should be included.
  """
  adaptToNewServicesFlag: Boolean!
  """
  Use this carrier service for this participant.
  """
  carrierService: DeliveryCarrierService!
  """
  The merchant-set fixed fee for this participant.
  """
  fixedFee: MoneyV2
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Services offered by the participant and their active status.
  """
  participantServices: [DeliveryParticipantService!]!
  """
  The merchant-set percentage-of-rate fee for this participant.
  """
  percentageOfRateFee: Float!
}

Implements

Fields

adaptToNewServicesFlag (Boolean!)

Flag to indicate if new available services should be included.

carrierService (DeliveryCarrierService!)

Use this carrier service for this participant.

fixedFee (MoneyV2)

The merchant-set fixed fee for this participant.

id (ID!)

Globally unique identifier.

participantServices ([DeliveryParticipantService!]!)

Services offered by the participant and their active status.

percentageOfRateFee (Float!)

The merchant-set percentage-of-rate fee for this participant.

Sign up for a Partner account to get started.

Sign up