Skip to main content

ShipmentMethod

Describes the method/provider that the shipment uses.

type ShipmentMethod implements Node {
  id: UUID!
  archivedAt: DateTime
  baseFees: Int!
  calculateFees(
    items: [ProductVariantVersionWithQuantityInput!]!
  ): Int!
  description: String!
  externalReference: String!
  feesPerItem: Int!
  feesPerKg: Int!
  isArchived: Boolean!
  name: String!
}

Fields​

ShipmentMethod.id ● UUID! non-null scalar​

UUID of the shipment method.

ShipmentMethod.archivedAt ● DateTime scalar​

If this shipment method is archived, the datetime it was archived.

ShipmentMethod.baseFees ● Int! non-null scalar​

The base fees for the shipment method.

ShipmentMethod.calculateFees ● Int! non-null scalar​

Calculates the fees for a potential shipment.

ShipmentMethod.calculateFees.items ● [ProductVariantVersionWithQuantityInput!]! non-null input​

The input for the calculation.

ShipmentMethod.description ● String! non-null scalar​

The description of the shipment method.

ShipmentMethod.externalReference ● String! non-null scalar​

The reference of the shipment method used by the external shipment provider.

ShipmentMethod.feesPerItem ● Int! non-null scalar​

The fees per item for the shipment method.

ShipmentMethod.feesPerKg ● Int! non-null scalar​

The fees per kg for the shipment method.

ShipmentMethod.isArchived ● Boolean! non-null scalar​

If true, this shipment method is archived and can no longer be used.

ShipmentMethod.name ● String! non-null scalar​

The name of the shipment method.

Interfaces​

Node interface​

An object with an ID.

Returned By​

archiveShipmentMethod mutation ● createShipmentMethod mutation ● shipmentMethod query

Member Of​

OrderItem object ● Shipment object ● ShipmentMethodConnection object