Skip to main content

RepaymentShipping

Permission required: repayment_shipping:read

type RepaymentShipping implements BaseShipping {
  address1: String
  address2: String
  bookingStatus: ShippingBookingStatus
  carrier: ShippingCarrier
  carrierName: String
  city: String
  companyName: String
  country: String
  createdAt: ISO8601DateTime
  email: String
  events: [ShippingEvent!]
  firstName: String
  id: ID
  isoCountry: String
  labels: [ShippingLabel!]
  lastName: String
  number: String
  parcels: [ShippingParcel!]
  proforma: AccountingRepaymentProforma
  province: String
  status: ShippingStatus
  telephone: String
  trackingNumber: String
  trackingUrl: String
  updatedAt: ISO8601DateTime
  warehouse: Warehouse
  zipCode: String
}

Fields​

RepaymentShipping.address1 ● String scalar​

The street address.

RepaymentShipping.address2 ● String scalar​

A secondary address line.

RepaymentShipping.bookingStatus ● ShippingBookingStatus enum​

The state of the shipping label (waybill) booking process for the return shipping. Null until the booking process starts.

RepaymentShipping.carrier ● ShippingCarrier object​

The carrier of the shipping.

RepaymentShipping.carrierName ● String scalar​

The name of the carrier.

RepaymentShipping.city ● String scalar​

The city.

RepaymentShipping.companyName ● String scalar​

The company name of the recipient.

RepaymentShipping.country ● String scalar​

The extended country name (for example Italy).

RepaymentShipping.createdAt ● ISO8601DateTime scalar​

When the record was created.

RepaymentShipping.email ● String scalar​

The email address of the recipient.

RepaymentShipping.events ● [ShippingEvent!] list object​

The tracking events received from the carrier.

RepaymentShipping.firstName ● String scalar​

The first name of the recipient.

RepaymentShipping.id ● ID scalar​

The unique identifier of the record.

RepaymentShipping.isoCountry ● String scalar​

The country, as an ISO 3166-1 alpha-2 code (for example IT).

RepaymentShipping.labels ● [ShippingLabel!] list object​

The waybills (shipping labels) of the return shipping: one label per parcel, so a multi-parcel return shipping has multiple labels.

RepaymentShipping.lastName ● String scalar​

The last name of the recipient.

RepaymentShipping.number ● String scalar​

The shipping number.

RepaymentShipping.parcels ● [ShippingParcel!] list object​

The parcels of the shipping.

RepaymentShipping.proforma ● AccountingRepaymentProforma object​

The proforma of the return shipping. A shipping has at most one proforma.

RepaymentShipping.province ● String scalar​

The province.

RepaymentShipping.status ● ShippingStatus enum​

The carrier tracking state of the parcel, read in the context of a return (delivered means the returned goods reached the warehouse). Null until the first tracking information is received from the carrier.

RepaymentShipping.telephone ● String scalar​

The telephone number of the recipient. Normalized to the 00 international notation at import.

RepaymentShipping.trackingNumber ● String scalar​

The tracking code assigned by the carrier.

RepaymentShipping.trackingUrl ● String scalar​

The tracking URL on the carrier's website.

RepaymentShipping.updatedAt ● ISO8601DateTime scalar​

When the record was last updated.

RepaymentShipping.warehouse ● Warehouse object​

The warehouse the returned goods are sent back to.

RepaymentShipping.zipCode ● String scalar​

The postal code.

Interfaces​

BaseShipping interface​

Member Of​

RepaymentRequest object