OBJECT
Shipment

A request from an end user (final consumer) to handle the return for an online order.
GraphQL Schema definition

type Shipment {
#   Full Address made of 'ship_from_' fields 
address: String 
#   Status of approval
approveStatus: String! 
#   Emergency alert that can be set to cancel the email reminders before a pickup.
cancelReminders: Boolean! 
#   Does user want to pay a fee to ensure the parcels
co2: Boolean 
#   Note that the user left to the courier
comments: String 
#   Country
country: String 
#   Timestamp of the pickup creation
createdAt: ISO8601DateTime! 
#   Public name of drop off provider
dropoffProviderName: String 
#   Url of the possible drop off locations close to end-user
dropoffProviderUrl: String 
#   Email of the user who made the booking.
email: String 
#   Shortcut to discern whether a pickup has delivery instructions.
hasComments: Boolean! 
#   Does it have an active investigation
hasInvestigation: Boolean! 
#   Shortcut to discern whether a pickup has notes or not.
hasNotes: Boolean! 
#   Unique identifier of the pickup
id: String! 
#   Does user want to pay a fee to ensure the parcels
insured: Boolean 
#   Show investigation associated
investigation: Investigation 
#   Dropoff label url
labelUrl: String 
#   User's locale
locale: String! 
#   Full name of the user who made the booking.
name: String 
#   Logistical network used in the return of this parcel
network: Networks 
#   Reminders or comments about this pickup written by a Customer Service Agent.
notes: [Note!]! 
#   The number of boxes to be picked up.
numberOfBoxes: Int 
#   Unique identifier within the shop ERP system.
orderNumber: String 
#   Last payment status
paymentStatus: String 
#   Link where end users can pay for their orders
paymentUrl: String 
#   Phone of the user who made the booking.
phone: String 
#   Shipment' price
price: Int! 
#   Latest shipment reference received in the system
ref: String 
#   Reason why the final user wants to perfom a return.
returnReason: ReturnReason 
#   Type of return: pickup at home or dropoff.
returnType: String! 
#   Address line where the parcel needs to be picked up.
shipFromAddressLine: String 
#   City where the parcel needs to be picked up.
shipFromCity: String 
#   Country code where the parcel needs to be picked up.
shipFromCountryCode: String 
#   House number where the parcel needs to be picked up.
shipFromHouseNumber: String 
#   Postal code where the parcel needs to be picked up.
shipFromPostalCode: String 
#   Street where the parcel needs to be picked up.
shipFromStreet: String 
#   City where the parcel needs to be drop off.
shipToCity: String! 
#   House number where the parcel needs to be drop off.
shipToHouseNumber: String! 
#   Postal code where the parcel needs to be drop off.
shipToPostalCode: String! 
#   Street where the parcel needs to be drop off.
shipToStreet: String! 
#   Shop which owns this pickup.
shop: Shop! 
#   Shop name which owns this pickup.
shopName: String! 
#   Size of parcel
size: String! 
#   Earliest desired time for the parcel to be pickedup.
start: ISO8601DateTime 
#   Reflects the current progress of the return process for this pickup.
status: String! 
#   Latest desired time for the parcel to be pickedup.
stop: ISO8601DateTime 
#   Did the end-user agree on terms and conditions?
termsAndConditions: Boolean! 
#   Identifier for the desired timeslot
timeslotId: String 
#   List of tracking updates for this pickup.
trackingUpdates: [TrackingUpdate!]! 
#   Tracking url
trackingUrl: String 
#   Timestamp of the last time that the pickup was updated.
updatedAt: ISO8601DateTime! 
#   Indicates if the user should pay in the future.
userShouldntPay: Boolean 
#   Item name that customer wants to exchange return item with
wantExchangeTo: String 
#   Indicates if the order has been paid.
wasPaid: Boolean 
}
Shipment

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
