Skip to main content

ShippingLabel

A shipping label created with a carrier, together with the tracking codes the carrier assigned to its parcels.

type ShippingLabel implements Node {
  id: ID!
  cancelled: Boolean!
  carrier: String!
  createdAt: DateTime!
  isReturnShipment: Boolean!
  labelDocuments: JSON!
  trackingCodes: JSON!
  updatedAt: DateTime
  orders(
    first: Int = 10
    after: String
    filter: OrderFilterInput
  ): OrderConnection
}

Fields​

ShippingLabel.id ● ID! non-null scalar​

Global identifier for this entity.

ShippingLabel.cancelled ● Boolean! non-null scalar​

True when the shipping label was cancelled with the carrier. Cancelled shipping labels stay listed.

ShippingLabel.carrier ● String! non-null scalar​

Technical name of the carrier the shipping label was created with, e.g. dhl or gls.

ShippingLabel.createdAt ● DateTime! non-null scalar​

Timestamp the shipping label was created.

ShippingLabel.isReturnShipment ● Boolean! non-null scalar​

True for a return label, i.e. a label for a parcel sent back to the merchant.

ShippingLabel.labelDocuments ● JSON! non-null scalar​

Documents the carrier issued for the shipping label, e.g. the label itself and customs documents: a list of objects with the keys documentType, fileName (may be null) and downloadUrl. The download URL is a path on the shop's API that serves the PDF without authentication, so it can be handed on, e.g. to the customer for a return label.

ShippingLabel.trackingCodes ● JSON! non-null scalar​

Tracking codes of the shipping label's parcels: a list of objects with the keys trackingCode, trackingUrl (null when the carrier offers no tracking page) and direction (outgoing for a parcel to the customer, incoming for a parcel back to the merchant).

ShippingLabel.updatedAt ● DateTime scalar​

Timestamp the shipping label was last changed, e.g. when it was cancelled.

ShippingLabel.orders ● OrderConnection object​

ShippingLabel.orders.first ● Int scalar​
ShippingLabel.orders.after ● String scalar​
ShippingLabel.orders.filter ● OrderFilterInput input​

Interfaces​

Node interface​

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By​

shippingLabel query

Member Of​

ShippingLabelEdge object