OBJECT
Query

GraphQL Schema definition

type Query {
# Arguments
#   postalCode: Postal code of the address
#   houseNumber: House number of the address
#   shopId: Unique id of the shop for which the address is resolved 
#   for. Admin only.
address(postalCode: String!, houseNumber: String!, shopId: String): Address 
# Arguments
#   shopId: Unique id of the shop for which the address is resolved 
#   for. Admin only.
branding(shopId: String): ShopBranding 
#   Returns all the shipments created by the shop admin
# 
# Arguments
#   page: Cursor to transverse the graph of objects.
#   perPage: How many shipments to show per page
#   sortKey: Attribute used to sort the results.
#   sortCriteria: Order, ascending or descending, preferred to sort 
#   the results.
dashboardDropoffs(
page: Int,
perPage: Int,
sortKey: ShipmentSortingCriteria,
sortCriteria: BaseEnum
): Shipments 
#   Get investigations
# 
# Arguments
#   scope: 
#   page: 
#   perPage: 
investigations(scope: String, page: Int, perPage: Int!): Investigations 
# Arguments
#   shopId: Unique id of the shop for which merchant is resolved
merchant(shopId: String): Merchant 
#   Returns the list of notes
# 
# Arguments
#   page: Number of page
#   perPage: Per page
#   shipmentId: Filter to load only notes related one shipment.
#   userId: Filter to load only notes related a user.
notes(page: Int, perPage: Int, shipmentId: String, userId: Int): [Note!] 
#   Returns all the shipments in the system visible for the current user matching a 
#   given search criteria
# 
# Arguments
#   query: Search key
#   page: Page number of shipments to show
#   perPage: How many shipments to show per page
#   sortKey: Attribute used to sort the results.
#   sortCriteria: Order, ascending or descending, preferred to sort 
#   the results.
search(
query: String!,
page: Int!,
perPage: Int!,
sortKey: ShipmentSortingCriteria,
sortCriteria: BaseEnum
): Shipments 
#   Returns shipment with id
# 
# Arguments
#   id: Filter to fetch a given shipment
shipment(id: String!): Shipment 
#   Returns all the shipments in the system visible for the current user
# 
# Arguments
#   id: Filter to fetch a given shipment
#   page: Cursor to transverse the graph of objects.
#   sortKey: Attribute used to sort the results.
#   sortCriteria: Order, ascending or descending, preferred to sort 
#   the results.
shipments(
id: String,
page: Int,
sortKey: ShipmentSortingCriteria,
sortCriteria: BaseEnum
): [Shipment!] 
#   Returns all the shipments in the system visible for the current user
# 
# Arguments
#   page: Cursor to transverse the graph of objects.
#   perPage: How many shipments to show per page
#   sortKey: Attribute used to sort the results.
#   sortCriteria: Order, ascending or descending, preferred to sort 
#   the results.
shipmentsWithMeta(
page: Int,
perPage: Int,
sortKey: ShipmentSortingCriteria,
sortCriteria: BaseEnum
): Shipments 
# Arguments
#   shopId: Unique id of the shop for which the address is 
#   resolved. Admin only.
shop(shopId: String): Shop 
# Arguments
#   page: Cursor to transverse the graph of objects.
shops(page: Int): [Shop!] 
# Arguments
#   from: Start of the required period
#   to: End of the required period
statsBilledCounters(from: ISO8601Date, to: ISO8601Date): JSON 
#   Returns aggregated data concerning the return parcels of a shop or shops.
# 
# Arguments
#   shopId: Unique identifier of the shop which to be looked up. 
#   Admin only.
#   from: Start of the required period
#   to: Stop of the required period
statsDailyCounters(
shopId: String,
from: ISO8601DateTime!,
to: ISO8601DateTime!
): [DailyCounters!] 
statsMonthlyCounters: JSON 
statsReturnReasonCounters: JSON 
# Arguments
#   from: Start of the required period
#   to: End of the required period
statsTotalCounters(from: ISO8601Date!, to: ISO8601Date!): JSON 
#   Returns all the the users of a given shop or fellow admins.
# 
# Arguments
#   shopId: Unique identifier of the shop to be looked up. Admin 
#   only.
team(shopId: String): [User!] 
#   Returns all the timeslots available for a given location and shop.
# 
# Arguments
#   postalCode: Postal code of the shipment address
#   shopId: Unique identifier for a given shop
#   network: Preferred logistical company to handle the return of 
#   the parcel
timeslots(postalCode: String!, shopId: String, network: String): [Timeslot!] 
}
Require by

This element is not required by anyone
Query

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
