OBJECT
Mutation

GraphQL Schema definition

type Mutation {
# Arguments
#   shipmentId: Shipment uuid
#   approved: Approve or not
approveShipment(shipmentId: String!, approved: Boolean!): Boolean 
# Arguments
#   id: Identifier of the shipment to be cancel.
#   shopId: ID of the shop which owns the shipment. Admin only.
cancelShipment(id: String!, shopId: String): Boolean 
# Arguments
#   email: Email of the user who is making the booking.
#   numberOfBoxes: Number of boxes to be picked up. 1-4
#   termsAndConditions: Adds another layer of validation for 
#   dropoff creation
#   size: Adds a size of parcel
#   locale: Preferred locale code of the user
#   network: Logistics network
#   insured: Adds a fee to ensure the parcel
#   name: Name of the customer. Used for gate keeping.
#   phone: Phone of the customer. Used for gate keeping.
#   returnReasonId: Reason of return id
#   customReturnReason: Reason of return written by hand
#   wantExchangeTo: Customer tells what it wants to exchange the 
#   good to
#   orderNumber: Identifier in the ERP shop's system
#   shopId: Unique identifier of the shop which the order is 
#   returned to. Admin only.
createDropoffShipment(
email: String!,
numberOfBoxes: Int!,
termsAndConditions: Boolean!,
size: String!,
locale: String!,
network: String!,
insured: Boolean!,
name: String,
phone: String,
returnReasonId: Int,
customReturnReason: String,
wantExchangeTo: String,
orderNumber: String,
shopId: ID
): Shipment 
# Arguments
#   shipFromPostalCode: Postal code of the user that sends parcel
#   shipFromCity: City of the user that sends parcel
#   shipFromAddressLine: Street and house of the user that sends 
#   parcel
#   name: Full name of the user who is making the booking.
#   email: Email of the user who is making the booking.
#   numberOfBoxes: Number of boxes to be picked up. 1-4
#   termsAndConditions: Adds another layer of validation for 
#   dropoff creation
#   countryCode: Country code of the user
#   size: Adds a size of parcel
#   locale: Preferred locale code of the user
#   insured: Adds a fee to ensure the parcel
#   phone: Phone of the customer. Used for gate keeping.
#   orderNumber: Identifier in the ERP shop's system
#   returnReasonId: Reason of return id
#   customReturnReason: Reason of return written by hand
#   wantExchangeTo: Customer tells what it wants to exchange the 
#   good to
#   shopId: Unique identifier of the shop which the order is 
#   returned to. Admin only.
createDropoffShipmentInt(
shipFromPostalCode: String!,
shipFromCity: String!,
shipFromAddressLine: String!,
name: String!,
email: String!,
numberOfBoxes: Int!,
termsAndConditions: Boolean!,
countryCode: String!,
size: String!,
locale: String!,
insured: Boolean!,
phone: String,
orderNumber: String,
returnReasonId: Int,
customReturnReason: String,
wantExchangeTo: String,
shopId: ID
): Shipment 
# Arguments
#   id: Uuid of the shipment
createLabelForShipment(id: String!): Shipment 
# Arguments
#   shipFromCountryCode: Country code of the user
#   shipFromPostalCode: Postal code of the user that sends parcel
#   shipFromCity: City of the user that sends parcel
#   shipFromAddressLine: Street and house of the user that sends 
#   parcel
#   name: Full name of the user who is making the booking.
#   email: Email of the user who is making the booking.
#   orderNumber: Identifier in the ERP shop's system
#   numberOfBoxes: Number of boxes to be picked up. 1-4
#   network: Carrier name
#   locale: Preferred locale code of the user
#   shopId: Admin only: id of the shop
createLabelInt(
shipFromCountryCode: String!,
shipFromPostalCode: String!,
shipFromCity: String!,
shipFromAddressLine: String!,
name: String!,
email: String!,
orderNumber: String!,
numberOfBoxes: Int!,
network: String!,
locale: String,
shopId: String
): Shipment 
# Arguments
#   email: Email of the user who is making the booking.
#   numberOfBoxes: Number of boxes. 1-4
#   orderNumber: Order number in the shop
#   network: Logistics carrier
#   locale: Preferred locale code of the user
#   shopId: Admin only: id of the shop
createLabelLocal(
email: String!,
numberOfBoxes: Int!,
orderNumber: String!,
network: String!,
locale: String,
shopId: String
): Shipment 
# Arguments
#   message: Contents of the note to be created.
#   shipmentId: Unique identifier of a shipment.
createNote(message: String!, shipmentId: String!): Note 
# Arguments
#   shipFromPostalCode: Postal code of the address where the parcel 
#   needs to be picked up
#   shipFromHouseNumber: House number of the address where the 
#   parcel needs to be picked up.
#   shipToPostalCode: Postal code of the shop location
#   shipToHouseNumber: House number of the shop location
#   shopName: Name of the shop
#   timeslotId: Identifier for the selected timeslot.
#   name: Full name of the user who is making the booking.
#   email: Email of the user who is making the booking.
#   numberOfBoxes: Number of boxes to be picked up. 1-4
#   orderNumber: Identifier in the ERP shop's system
#   comments: Notes that the user left to the courier.
#   insured: Adds a fee to ensure the parcel
#   co2: Adds a fee per parcel for using CO2 compensation
createPartnerPickup(
shipFromPostalCode: String!,
shipFromHouseNumber: String!,
shipToPostalCode: String!,
shipToHouseNumber: String!,
shopName: String!,
timeslotId: String!,
name: String!,
email: String!,
numberOfBoxes: Int!,
orderNumber: String,
comments: String,
insured: Boolean,
co2: Boolean
): Shipment 
# Arguments
#   shipFromPostalCode: Postal code of the address where the parcel 
#   needs to be picked up
#   shipFromHouseNumber: House number of the address where the 
#   parcel needs to be picked up.
#   timeslotId: Identifier for the selected timeslot.
#   name: Full name of the user who is making the booking.
#   email: Email of the user who is making the booking.
#   numberOfBoxes: Number of boxes to be picked up. 1-4
#   termsAndConditions: Adds another layer of validation for pickup 
#   creation
#   locale: User's preferred language
#   phone: Phone of the customer. Used for gate keeping.
#   comments: Notes that the user left to the courier.
#   orderNumber: Identifier in the ERP shop's system
#   shopId: Unique identifier of the shop which the order is 
#   returned to. Admin only.
#   insured: Adds a fee to ensure the parcel
#   returnReasonId: Reason of return id
#   customReturnReason: Reason of return written by hand
#   wantExchangeTo: Customer tells what it wants to exchange the 
#   good to
createPickupShipment(
shipFromPostalCode: String!,
shipFromHouseNumber: String!,
timeslotId: String!,
name: String!,
email: String!,
numberOfBoxes: Int!,
termsAndConditions: Boolean!,
locale: String!,
phone: String,
comments: String,
orderNumber: String,
shopId: ID,
insured: Boolean,
returnReasonId: Int,
customReturnReason: String,
wantExchangeTo: String
): Shipment 
# Arguments
#   shipFromPostalCode: Postal code of the address where the parcel 
#   needs to be picked up
#   shipFromCity: Postal code of the address where the parcel needs 
#   to be picked up
#   shipFromAddressLine: Street and house of the user that sends 
#   parcel
#   pickupDate: Date when to pickup
#   name: Full name of the user who is making the booking.
#   email: Email of the user who is making the booking.
#   numberOfBoxes: Number of boxes to be picked up. 1-4
#   termsAndConditions: Adds another layer of validation for pickup 
#   creation
#   countryCode: Country code of the user
#   locale: User's preferred language
#   insured: Adds a fee to ensure the parcel
#   phone: Phone of the customer. Used for gate keeping.
#   orderNumber: Identifier in the ERP shop's system
#   shopId: Unique identifier of the shop which the order is 
#   returned to. Admin only.
#   comments: Notes that the user left to the courier.
#   returnReasonId: Reason of return id
#   customReturnReason: Reason of return written by hand
#   wantExchangeTo: Customer tells what it wants to exchange the 
#   good to
createPickupShipmentInt(
shipFromPostalCode: String!,
shipFromCity: String!,
shipFromAddressLine: String!,
pickupDate: String!,
name: String!,
email: String!,
numberOfBoxes: Int!,
termsAndConditions: Boolean!,
countryCode: String!,
locale: String!,
insured: Boolean!,
phone: String,
orderNumber: String,
shopId: ID,
comments: String,
returnReasonId: Int,
customReturnReason: String,
wantExchangeTo: String
): Shipment 
# Arguments
#   id: Unique identifer of the note to be removed.
deleteNote(id: String!): Note 
# Arguments
#   email: Email address of the user being invited.
deleteUser(email: String!): Boolean 
# Arguments
#   email: Email address of the user being invited.
#   firstName: First name of the user being invited.
#   lastName: Last name of the user being invited.
inviteUser(email: String!, firstName: String!, lastName: String!): User 
# Arguments
#   shipmentId: Shipment uuid
proceedWithShipment(shipmentId: String!): Shipment 
# Arguments
#   token: Devise reset or confirmation token
#   password: New password
#   purpose: Purpose: "reset password" or "confirm registration"
resetProfilePassword(
token: String!,
password: String!,
purpose: Purpose!
): Credentials 
# Arguments
#   email: Email address
sendResetPasswordUrl(email: String!): String 
# Arguments
#   id: Shipment id.
#   message: Message to start investigation
startInvestigation(id: String!, message: String): Boolean 
# Arguments
#   id: Investigation uuid.
#   resolved: Is issue resolved?
toggleInvestigationStatus(
id: String!,
resolved: Boolean
): Boolean 
# Arguments
#   id: Unique identifer of the note to be updated.
#   message: Contents of the note to be updated.
updateNote(id: String!, message: String!): Note 
# Arguments
#   id: Unique identifier of the pickup intended to be updated.
#   shipFromPostalCode: Postal code of the address where the 
#   parcels needs to be picked up.
#   shipFromCity: City of the address where the parcels needs to be 
#   picked up.
#   shipFromStreet: Street of the address where the parcel needs to 
#   be picked up.
#   shipFromHouseNumber: House number of the address where the 
#   parcel needs to be picked up.
#   shipFromAddressLine: House number of the address where the 
#   parcel needs to be picked up.
#   timeslotId: Identifier for the selected timeslot.
#   name: Name of the user to be updated
#   email: Email of the user to be updated
#   numberOfBoxes: Number of boxes to be picked up.
#   comments: Note that the user left to the courier.
#   orderNumber: Unique identifier in the shop's ERP system.
#   silentUpdate: Indicates whether the user should be notified 
#   through mail after the update or not
#   userShouldntPay: Indicates whether the user should pay for the 
#   shipment
updatePickupShipment(
id: String!,
shipFromPostalCode: String!,
shipFromCity: String!,
shipFromStreet: String!,
shipFromHouseNumber: String!,
shipFromAddressLine: String,
timeslotId: String!,
name: String,
email: String!,
numberOfBoxes: Int!,
comments: String!,
orderNumber: String!,
silentUpdate: Boolean,
userShouldntPay: Boolean
): Shipment 
# Arguments
#   firstName: First name in profile
#   lastName: Last name in profile
updateProfileName(firstName: String!, lastName: String!): Credentials 
# Arguments
#   oldPassword: Old password
#   newPassword: New password
updateProfilePassword(
oldPassword: String!,
newPassword: String!
): Credentials 
}
Require by

This element is not required by anyone
Mutation

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
