Queries#

Returns: Account

query {
  account {
    email
    given_name
    family_name
    orders(first: 10) {
      nodes {
        id
        number
        total
      }
    }
  }
}

Returns: Address

query GetAddress($id: String!) {
  address(id: $id) {
    id
    address_line_1
    address_line_2
    locality
    postal_code
    country_code
    administrative_area
    dependent_locality
  }
}

{
  "id": "8f2e4a71-b3c9-4d5e-a1f0-6789abcd0123"
}

query AddressOptionsQuery($country_code: String) {
  addressOptions(country_code: $country_code) {
    country_code
    required
    allowed
    format {
      postal_code
      address_line_1
    }
    administrative_areas {
      code
      name
    }
  }
}

{
  "country_code": "NL"
}

query AgreementQuery($id: ID!) {
  agreement(id: $id) {
    id
    name
    type
    description
    instructions
    is_default_enabled
    conditions {
      type
      amount
      is_percentage
    }
    created_at
  }
}

{
  "id": "agr_x9k2mQ"
}

query AgreementsQuery($first: Int, $after: String) {
  agreements(first: $first, after: $after) {
    nodes {
      id
      name
      type
      is_default_enabled
      conditions {
        type
        amount
        is_percentage
      }
      created_at
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10,
  "after": null
}

query AnnouncementQuery($id: String!) {
  announcement(id: $id) {
    id
    number
    state
    description
    expected_at
    supplier {
      id
      name
    }
    items {
      sku
      state
      cost_price
    }
    statistics {
      items
      pending
      received
    }
    created_at
  }
}

{
  "id": "ann_7hR4tW"
}

query AnnouncementItemQuery($id: String!) {
  announcementItem(id: $id) {
    id
    sku
    state
    cost_price
    specification {
      batch_number
      serial_number
    }
    announcement {
      id
      number
      expected_at
    }
    product {
      sku
      label
      brand
    }
    created_at
  }
}

{
  "id": "ani_3fJ8pL"
}

query AnnouncementsQuery($first: Int, $filters: AnnouncementsFilterInput!) {
  announcements(first: $first, filters: $filters) {
    announcements {
      id
      number
      state
      expected_at
      supplier {
        name
      }
      statistics {
        items
        pending
        received
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10,
  "filters": {
    "state": "PENDING",
    "location_id": "loc_8dK3nB"
  }
}

query BucketQuery($id: String!) {
  bucket(id: $id) {
    id
    name
    code
    endpoint
    integrations {
      id
      name
      app_code
      is_installed
    }
    created_at
  }
}

{
  "id": "bkt_5wQ9rT"
}

query BucketsQuery($first: Int, $orderBy: BucketsOrderByInput) {
  buckets(first: $first, orderBy: $orderBy) {
    buckets {
      id
      name
      code
      endpoint
      created_at
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10,
  "orderBy": {
    "created_at": "DESC"
  }
}

Returns: Business

query GetBusiness($id: String!) {
  business(id: $id) {
    id
    name
    email
    addressing {
      visiting {
        address_line_1
        locality
        postal_code
        country_code
      }
    }
    openings {
      day
      open
      close
    }
  }
}

{
  "id": "3c7d1e5f-9a2b-4f8e-b6d0-1234abcd5678"
}

Returns: Business

query ListBusinesses($first: Int) {
  businesses(first: $first) {
    businesses {
      id
      name
      type
      email
      addressing {
        visiting {
          address_line_1
          locality
          country_code
        }
      }
      openings {
        day_of_week
        windows {
          start
          end
        }
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10
}

Returns: Cart

query GetCart($id: String!) {
  cart(id: $id) {
    id
    number
    total
    currency
    is_including_vat
    items {
      label
      quantity
      total
      sku
    }
    delivery {
      address {
        address_line_1
        locality
        postal_code
        country_code
      }
    }
    checkout {
      url
    }
  }
}

{"id": "72fca344-2a6f-4c3e-b4ca-029920b2522a"}

Returns: Channel

query GetChannel {
  channel {
    id
    name
    locale
    branding {
      colors {
        primary
        secondary
      }
    }
  }
}

query ClaimQuery($id: String!) {
  claim(id: $id) {
    id
    quantity
    state
    expires_at
    product {
      sku
      label
    }
    warehouse {
      id
      label
    }
    business {
      id
      name
    }
    created_at
  }
}

{
  "id": "clm_2vN6xD"
}

query GetComment($id: String!) {
  comment(id: $id) {
    id
    body
    created_at
    user {
      id
      name
      email
    }
    task {
      id
      title
      status
    }
  }
}

{
  "id": "cmt_8fK2nQ"
}

Returns: Contact

query GetContact($id: String!) {
  contact(id: $id) {
    id
    email
    given_name
    family_name
    is_verified
    addressing {
      shipping {
        primary {
          address_line_1
          locality
          postal_code
          country_code
        }
      }
    }
  }
}

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

query GetDelivery($id: String!) {
  delivery(id: $id) {
    id
    number
    status
    handle_at
    expected_at
    method {
      name
      carrier
    }
    to {
      address {
        locality
        postal_code
        country_code
      }
    }
    parcels {
      id
      number
      status
      track_trace {
        url
        number
      }
    }
  }
}

{
  "id": "dlv_4Hj8sK"
}

query GetDeliveryRequest($id: String!) {
  deliveryRequest(id: $id) {
    id
    number
    state
    description
    currency
    close_at
    sender {
      supplier {
        id
        name
      }
    }
    items {
      id
      sku
      state
      cost_price
    }
    created_at
  }
}

{
  "id": "dvr_7Km3pW"
}

query GetDeliveryRequestItem($id: String!) {
  deliveryRequestItem(id: $id) {
    id
    sku
    state
    cost_price
    position
    request {
      id
      number
      close_at
    }
    product {
      sku
      label
      brand
    }
    order {
      id
      number
    }
  }
}

{
  "id": "dri_2Nc7vB"
}

query GetDrawer($id: String!) {
  drawer(id: $id) {
    id
    label
    status
    starting_amount
    expected_amount
    last_started_at
    last_closed_at
    channel {
      id
      name
    }
  }
}

{
  "id": "drw_x9k2mQ"
}

query GetDrawerMutation($id: String!) {
  drawerMutation(id: $id) {
    id
    type
    note
    amount
    status
    drawer {
      id
      label
      status
    }
    created_at
  }
}

{
  "id": "drm_5Tq8wZ"
}

query GetDrawerReport($id: String!) {
  drawerReport(id: $id) {
    id
    start_at
    end_at
    starting_amount
    expected_amount
    actual_amount
    skimmed_amount
    closing_amount
    drawer {
      id
      label
    }
    user {
      name
    }
    mutations {
      id
      type
      amount
      note
    }
  }
}

{
  "id": "drp_9Lm4xT"
}

query ListDrawerReports($first: Int, $filters: DrawerReportsFilterInput) {
  drawerReports(first: $first, filters: $filters) {
    nodes {
      id
      start_at
      end_at
      starting_amount
      expected_amount
      actual_amount
      closing_amount
      drawer {
        id
        label
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10,
  "filters": {
    "drawer_id": ["drw_x9k2mQ"],
    "is_open": false
  }
}

query ListDrawers($first: Int, $filters: DrawersFilterInput!) {
  drawers(first: $first, filters: $filters) {
    nodes {
      id
      label
      status
      starting_amount
      expected_amount
      last_started_at
      channel {
        id
        name
      }
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "first": 10,
  "filters": {
    "channel_ids": ["chn_3Fb9kR"],
    "state": ["OPEN"]
  }
}