PDV Mundo GraphQL API Reference

This guide aims to assist developers in comprehensively understanding and utilizing the PDV Mundo GraphQL API. It outlines the range of operations, queries, and data types that the API supports.

API Endpoints
https://api.pdvmundo.com.br/graphql
Headers
# To authenticate you need an API key. Please contact support.
Authorization: Bearer <YOUR_API_KEY>

Queries

answers

Description

Find answers

Response

Returns an AnswerPaginator!

Arguments
Name Description
orderBy - [QueryAnswersOrderByOrderByClause!]
question_id - ID Search by questionnaire id.
questionnaire_answer_id - ID Search by questionnaire answer id.
product_id - ID Search by product id.
product_category_id - ID Search by product category id.
answered_at - DateTimeRange Search by answers answered between two dates.
first - Int! Limits number of fetched items. Default = 10
page - Int The offset from which items are returned.

Example

Query
query Answers(
  $orderBy: [QueryAnswersOrderByOrderByClause!],
  $question_id: ID,
  $questionnaire_answer_id: ID,
  $product_id: ID,
  $product_category_id: ID,
  $answered_at: DateTimeRange,
  $first: Int!,
  $page: Int
) {
  answers(
    orderBy: $orderBy,
    question_id: $question_id,
    questionnaire_answer_id: $questionnaire_answer_id,
    product_id: $product_id,
    product_category_id: $product_category_id,
    answered_at: $answered_at,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      question_id
      questionnaire_answer_id
      questionnaire_item_id
      product_id
      product_category_id
      type
      subtype
      answered_at
      question {
        id
        text
        type
        created_at
        updated_at
      }
      product {
        id
        product_category_id
        brand_id
        name
        active
        category {
          ...ProductCategoryFragment
        }
        created_at
        updated_at
      }
      content {
        ... on AnswerBoolean {
          ...AnswerBooleanFragment
        }
        ... on AnswerChoice {
          ...AnswerChoiceFragment
        }
        ... on AnswerDate {
          ...AnswerDateFragment
        }
        ... on AnswerFile {
          ...AnswerFileFragment
        }
        ... on AnswerNumeric {
          ...AnswerNumericFragment
        }
        ... on AnswerText {
          ...AnswerTextFragment
        }
      }
      created_at
      updated_at
    }
  }
}
Variables
{
  "orderBy": [QueryAnswersOrderByOrderByClause],
  "question_id": 4,
  "questionnaire_answer_id": "4",
  "product_id": "4",
  "product_category_id": 4,
  "answered_at": DateTimeRange,
  "first": 10,
  "page": 123
}
Response
{
  "data": {
    "answers": {
      "paginatorInfo": PaginatorInfo,
      "data": [Answer]
    }
  }
}
Queries

businessUnit

Description

Buscar uma business unit pelo ID

Response

Returns a BusinessUnit

Arguments
Name Description
id - ID!

Example

Query
query BusinessUnit($id: ID!) {
  businessUnit(id: $id) {
    id
    name
    contract_value
    contract_time
    cost_serving_rule_in_min
    cost_serving_rule_alert_min
    cost_serving_rule_out_min
    chain_billing_apportionment_type
    pointOfSales {
      id
      name
      zip_code
      address
      number
      district
      complement
      external_code
      chain_external_code
      cnpj
      is_active
      category {
        id
        name
        created_at
        updated_at
      }
      chain {
        id
        name
        created_at
        updated_at
      }
      channel {
        id
        name
        created_at
        updated_at
      }
      regional {
        id
        name
        created_at
        updated_at
      }
      flag {
        id
        name
        created_at
        updated_at
      }
      city {
        id
        title
        iso
        slug
        state {
          ...StateFragment
        }
      }
      state {
        id
        title
        letter
        iso
        slug
      }
      location {
        latitude
        longitude
      }
      commercial_responsible {
        name
        email
      }
      merchandising_responsible {
        name
        email
      }
      created_at
      updated_at
    }
    businessUnitChecks {
      id
      work_schedule_id
      datetime_in
      datetime_out
      timezone_in
      timezone_out
      battery_in
      battery_out
      hash
      hash_out
      hash_pos_check
      business_unit {
        id
        name
        contract_value
        contract_time
        cost_serving_rule_in_min
        cost_serving_rule_alert_min
        cost_serving_rule_out_min
        chain_billing_apportionment_type
        pointOfSales {
          ...PointOfSaleFragment
        }
        businessUnitChecks {
          ...BusinessUnitCheckFragment
        }
        created_at
        updated_at
      }
      user {
        id
        tenant_id
        name
        email
        email_verified_at
        created_at
        updated_at
      }
      point_of_sale_check {
        id
        datetime_in
        datetime_out
        timezone_in
        timezone_out
        battery_in
        battery_out
        distance_in
        distance_out
        elapsed_time
        forced_checkout
        location_in {
          ...PointFragment
        }
        location_out {
          ...PointFragment
        }
        hash
        hash_out
        point_of_sale {
          ...PointOfSaleFragment
        }
        user {
          ...UserFragment
        }
        business_unit_checks {
          ...BusinessUnitCheckFragment
        }
        file_checkin
        file_checkout
        created_at
        updated_at
      }
      work_schedule {
        id
        schedule_date
        status
        created_at
        updated_at
      }
      point_of_sale {
        id
        name
        zip_code
        address
        number
        district
        complement
        external_code
        chain_external_code
        cnpj
        is_active
        category {
          ...PointOfSaleCategoryFragment
        }
        chain {
          ...ChainFragment
        }
        channel {
          ...ChannelFragment
        }
        regional {
          ...RegionalFragment
        }
        flag {
          ...FlagFragment
        }
        city {
          ...CityFragment
        }
        state {
          ...StateFragment
        }
        location {
          ...PointFragment
        }
        commercial_responsible {
          ...ResponsibleContactFragment
        }
        merchandising_responsible {
          ...ResponsibleContactFragment
        }
        created_at
        updated_at
      }
      created_at
      updated_at
    }
    created_at
    updated_at
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "businessUnit": {
      "id": 4,
      "name": "abc123",
      "contract_value": 987.65,
      "contract_time": 123,
      "cost_serving_rule_in_min": 987,
      "cost_serving_rule_alert_min": 123,
      "cost_serving_rule_out_min": 123,
      "chain_billing_apportionment_type": "xyz789",
      "pointOfSales": [PointOfSale],
      "businessUnitChecks": [BusinessUnitCheck],
      "created_at": "2018-05-23 13:43:32",
      "updated_at": "2018-05-23 13:43:32"
    }
  }
}
Queries

businessUnitChecks

Description

Buscar checks de business units

Response

Returns a BusinessUnitCheckPaginator!

Arguments
Name Description
orderBy - [QueryBusinessUnitChecksOrderByOrderByClause!]
user_id - ID Filtrar por ID do usuário
business_unit_id - ID Filtrar por ID da business unit
point_of_sales_check_id - ID Filtrar por ID do ponto de venda check
work_schedule_id - ID Filtrar por ID do work schedule
datetime_in - DateTimeRange Filtrar por data de check-in
datetime_out - DateTimeRange Filtrar por data de check-out
hash - String Filtrar por hash
first - Int! Limits number of fetched items. Default = 10
page - Int The offset from which items are returned.

Example

Query
query BusinessUnitChecks(
  $orderBy: [QueryBusinessUnitChecksOrderByOrderByClause!],
  $user_id: ID,
  $business_unit_id: ID,
  $point_of_sales_check_id: ID,
  $work_schedule_id: ID,
  $datetime_in: DateTimeRange,
  $datetime_out: DateTimeRange,
  $hash: String,
  $first: Int!,
  $page: Int
) {
  businessUnitChecks(
    orderBy: $orderBy,
    user_id: $user_id,
    business_unit_id: $business_unit_id,
    point_of_sales_check_id: $point_of_sales_check_id,
    work_schedule_id: $work_schedule_id,
    datetime_in: $datetime_in,
    datetime_out: $datetime_out,
    hash: $hash,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      work_schedule_id
      datetime_in
      datetime_out
      timezone_in
      timezone_out
      battery_in
      battery_out
      hash
      hash_out
      hash_pos_check
      business_unit {
        id
        name
        contract_value
        contract_time
        cost_serving_rule_in_min
        cost_serving_rule_alert_min
        cost_serving_rule_out_min
        chain_billing_apportionment_type
        pointOfSales {
          ...PointOfSaleFragment
        }
        businessUnitChecks {
          ...BusinessUnitCheckFragment
        }
        created_at
        updated_at
      }
      user {
        id
        tenant_id
        name
        email
        email_verified_at
        created_at
        updated_at
      }
      point_of_sale_check {
        id
        datetime_in
        datetime_out
        timezone_in
        timezone_out
        battery_in
        battery_out
        distance_in
        distance_out
        elapsed_time
        forced_checkout
        location_in {
          ...PointFragment
        }
        location_out {
          ...PointFragment
        }
        hash
        hash_out
        point_of_sale {
          ...PointOfSaleFragment
        }
        user {
          ...UserFragment
        }
        business_unit_checks {
          ...BusinessUnitCheckFragment
        }
        file_checkin
        file_checkout
        created_at
        updated_at
      }
      work_schedule {
        id
        schedule_date
        status
        created_at
        updated_at
      }
      point_of_sale {
        id
        name
        zip_code
        address
        number
        district
        complement
        external_code
        chain_external_code
        cnpj
        is_active
        category {
          ...PointOfSaleCategoryFragment
        }
        chain {
          ...ChainFragment
        }
        channel {
          ...ChannelFragment
        }
        regional {
          ...RegionalFragment
        }
        flag {
          ...FlagFragment
        }
        city {
          ...CityFragment
        }
        state {
          ...StateFragment
        }
        location {
          ...PointFragment
        }
        commercial_responsible {
          ...ResponsibleContactFragment
        }
        merchandising_responsible {
          ...ResponsibleContactFragment
        }
        created_at
        updated_at
      }
      created_at
      updated_at
    }
  }
}
Variables
{
  "orderBy": [
    QueryBusinessUnitChecksOrderByOrderByClause
  ],
  "user_id": "4",
  "business_unit_id": 4,
  "point_of_sales_check_id": "4",
  "work_schedule_id": 4,
  "datetime_in": DateTimeRange,
  "datetime_out": DateTimeRange,
  "hash": "abc123",
  "first": 10,
  "page": 987
}
Response
{
  "data": {
    "businessUnitChecks": {
      "paginatorInfo": PaginatorInfo,
      "data": [BusinessUnitCheck]
    }
  }
}
Queries

pointOfSaleChecks

Description

Buscar checks de pontos de venda

Response

Returns a PointOfSaleCheckPaginator!

Arguments
Name Description
orderBy - [QueryPointOfSaleChecksOrderByOrderByClause!]
user_id - ID Filtrar por ID do usuário
point_of_sale_id - ID Filtrar por ID do ponto de venda
datetime_in - DateTimeRange Filtrar por data de check-in
datetime_out - DateTimeRange Filtrar por data de check-out
hash - String Filtrar por hash
first - Int! Limits number of fetched items. Default = 10
page - Int The offset from which items are returned.

Example

Query
query PointOfSaleChecks(
  $orderBy: [QueryPointOfSaleChecksOrderByOrderByClause!],
  $user_id: ID,
  $point_of_sale_id: ID,
  $datetime_in: DateTimeRange,
  $datetime_out: DateTimeRange,
  $hash: String,
  $first: Int!,
  $page: Int
) {
  pointOfSaleChecks(
    orderBy: $orderBy,
    user_id: $user_id,
    point_of_sale_id: $point_of_sale_id,
    datetime_in: $datetime_in,
    datetime_out: $datetime_out,
    hash: $hash,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      datetime_in
      datetime_out
      timezone_in
      timezone_out
      battery_in
      battery_out
      distance_in
      distance_out
      elapsed_time
      forced_checkout
      location_in {
        latitude
        longitude
      }
      location_out {
        latitude
        longitude
      }
      hash
      hash_out
      point_of_sale {
        id
        name
        zip_code
        address
        number
        district
        complement
        external_code
        chain_external_code
        cnpj
        is_active
        category {
          ...PointOfSaleCategoryFragment
        }
        chain {
          ...ChainFragment
        }
        channel {
          ...ChannelFragment
        }
        regional {
          ...RegionalFragment
        }
        flag {
          ...FlagFragment
        }
        city {
          ...CityFragment
        }
        state {
          ...StateFragment
        }
        location {
          ...PointFragment
        }
        commercial_responsible {
          ...ResponsibleContactFragment
        }
        merchandising_responsible {
          ...ResponsibleContactFragment
        }
        created_at
        updated_at
      }
      user {
        id
        tenant_id
        name
        email
        email_verified_at
        created_at
        updated_at
      }
      business_unit_checks {
        id
        work_schedule_id
        datetime_in
        datetime_out
        timezone_in
        timezone_out
        battery_in
        battery_out
        hash
        hash_out
        hash_pos_check
        business_unit {
          ...BusinessUnitFragment
        }
        user {
          ...UserFragment
        }
        point_of_sale_check {
          ...PointOfSaleCheckFragment
        }
        work_schedule {
          ...WorkScheduleFragment
        }
        point_of_sale {
          ...PointOfSaleFragment
        }
        created_at
        updated_at
      }
      file_checkin
      file_checkout
      created_at
      updated_at
    }
  }
}
Variables
{
  "orderBy": [QueryPointOfSaleChecksOrderByOrderByClause],
  "user_id": "4",
  "point_of_sale_id": 4,
  "datetime_in": DateTimeRange,
  "datetime_out": DateTimeRange,
  "hash": "abc123",
  "first": 10,
  "page": 987
}
Response
{
  "data": {
    "pointOfSaleChecks": {
      "paginatorInfo": PaginatorInfo,
      "data": [PointOfSaleCheck]
    }
  }
}
Queries

pointOfSales

Description

Find point of sales

Response

Returns a PointOfSalePaginator!

Arguments
Name Description
orderBy - [QueryPointOfSalesOrderByOrderByClause!]
is_active - Boolean Search by active status.
updated_at - DateTimeRange Search by point of sales updated between two dates.
first - Int! Limits number of fetched items. Default = 10
page - Int The offset from which items are returned.

Example

Query
query PointOfSales(
  $orderBy: [QueryPointOfSalesOrderByOrderByClause!],
  $is_active: Boolean,
  $updated_at: DateTimeRange,
  $first: Int!,
  $page: Int
) {
  pointOfSales(
    orderBy: $orderBy,
    is_active: $is_active,
    updated_at: $updated_at,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      name
      zip_code
      address
      number
      district
      complement
      external_code
      chain_external_code
      cnpj
      is_active
      category {
        id
        name
        created_at
        updated_at
      }
      chain {
        id
        name
        created_at
        updated_at
      }
      channel {
        id
        name
        created_at
        updated_at
      }
      regional {
        id
        name
        created_at
        updated_at
      }
      flag {
        id
        name
        created_at
        updated_at
      }
      city {
        id
        title
        iso
        slug
        state {
          ...StateFragment
        }
      }
      state {
        id
        title
        letter
        iso
        slug
      }
      location {
        latitude
        longitude
      }
      commercial_responsible {
        name
        email
      }
      merchandising_responsible {
        name
        email
      }
      created_at
      updated_at
    }
  }
}
Variables
{
  "orderBy": [QueryPointOfSalesOrderByOrderByClause],
  "is_active": true,
  "updated_at": DateTimeRange,
  "first": 10,
  "page": 123
}
Response
{
  "data": {
    "pointOfSales": {
      "paginatorInfo": PaginatorInfo,
      "data": [PointOfSale]
    }
  }
}
Queries

products

Description

Find products

Response

Returns a ProductPaginator!

Arguments
Name Description
orderBy - [QueryProductsOrderByOrderByClause!]
active - Boolean Search by active status.
first - Int! Limits number of fetched items. Default = 10
page - Int The offset from which items are returned.

Example

Query
query Products(
  $orderBy: [QueryProductsOrderByOrderByClause!],
  $active: Boolean,
  $first: Int!,
  $page: Int
) {
  products(
    orderBy: $orderBy,
    active: $active,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      product_category_id
      brand_id
      name
      active
      category {
        id
        name
        created_at
        updated_at
      }
      created_at
      updated_at
    }
  }
}
Variables
{
  "orderBy": [QueryProductsOrderByOrderByClause],
  "active": false,
  "first": 10,
  "page": 123
}
Response
{
  "data": {
    "products": {
      "paginatorInfo": PaginatorInfo,
      "data": [Product]
    }
  }
}
Queries

questionnaireAnswers

Description

Find questionnaire answers

Response

Returns a QuestionnaireAnswerPaginator!

Arguments
Name Description
orderBy - [QueryQuestionnaireAnswersOrderByOrderByClause!]
questionnaire_id - ID Search by questionnaire id.
user_id - ID Search by user id.
point_of_sale_id - ID Search by point of sale id.
business_unit_id - ID Search by business unit id.
product_id - ID Search by product id.
product_category_id - ID Search by product category id.
answered_at - DateTimeRange Search by questionnaires answered between two dates.
first - Int! Limits number of fetched items. Default = 10
page - Int The offset from which items are returned.

Example

Query
query QuestionnaireAnswers(
  $orderBy: [QueryQuestionnaireAnswersOrderByOrderByClause!],
  $questionnaire_id: ID,
  $user_id: ID,
  $point_of_sale_id: ID,
  $business_unit_id: ID,
  $product_id: ID,
  $product_category_id: ID,
  $answered_at: DateTimeRange,
  $first: Int!,
  $page: Int
) {
  questionnaireAnswers(
    orderBy: $orderBy,
    questionnaire_id: $questionnaire_id,
    user_id: $user_id,
    point_of_sale_id: $point_of_sale_id,
    business_unit_id: $business_unit_id,
    product_id: $product_id,
    product_category_id: $product_category_id,
    answered_at: $answered_at,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      user_id
      tenant_id
      questionnaire_id
      point_of_sale_id
      business_unit_id
      product_id
      product_category_id
      user {
        id
        tenant_id
        name
        email
        email_verified_at
        created_at
        updated_at
      }
      questionnaire {
        id
        name
        type
        is_justifiable
        created_at
        updated_at
        items {
          ...QuestionnaireItemFragment
        }
      }
      answers {
        id
        question_id
        questionnaire_answer_id
        questionnaire_item_id
        product_id
        product_category_id
        type
        subtype
        answered_at
        question {
          ...QuestionFragment
        }
        product {
          ...ProductFragment
        }
        content {
          ... on AnswerBoolean {
            ...AnswerBooleanFragment
          }
          ... on AnswerChoice {
            ...AnswerChoiceFragment
          }
          ... on AnswerDate {
            ...AnswerDateFragment
          }
          ... on AnswerFile {
            ...AnswerFileFragment
          }
          ... on AnswerNumeric {
            ...AnswerNumericFragment
          }
          ... on AnswerText {
            ...AnswerTextFragment
          }
        }
        created_at
        updated_at
      }
      product {
        id
        product_category_id
        brand_id
        name
        active
        category {
          ...ProductCategoryFragment
        }
        created_at
        updated_at
      }
      category {
        id
        name
        created_at
        updated_at
      }
      answered_at
    }
  }
}
Variables
{
  "orderBy": [
    QueryQuestionnaireAnswersOrderByOrderByClause
  ],
  "questionnaire_id": 4,
  "user_id": 4,
  "point_of_sale_id": "4",
  "business_unit_id": 4,
  "product_id": 4,
  "product_category_id": 4,
  "answered_at": DateTimeRange,
  "first": 10,
  "page": 987
}
Response
{
  "data": {
    "questionnaireAnswers": {
      "paginatorInfo": PaginatorInfo,
      "data": [QuestionnaireAnswer]
    }
  }
}
Queries

questionnaires

Description

Find questionnaires.

Response

Returns a QuestionnairePaginator!

Arguments
Name Description
orderBy - [QueryQuestionnairesOrderByOrderByClause!]
type - String Search by questionnaire type.
first - Int! Limits number of fetched items. Default = 10
page - Int The offset from which items are returned.

Example

Query
query Questionnaires(
  $orderBy: [QueryQuestionnairesOrderByOrderByClause!],
  $type: String,
  $first: Int!,
  $page: Int
) {
  questionnaires(
    orderBy: $orderBy,
    type: $type,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      name
      type
      is_justifiable
      created_at
      updated_at
      items {
        id
        next_id
        is_required
        is_end
        question {
          ...QuestionFragment
        }
      }
    }
  }
}
Variables
{
  "orderBy": [QueryQuestionnairesOrderByOrderByClause],
  "type": "abc123",
  "first": 10,
  "page": 987
}
Response
{
  "data": {
    "questionnaires": {
      "paginatorInfo": PaginatorInfo,
      "data": [Questionnaire]
    }
  }
}
Queries

questions

Description

Find questions

Response

Returns a QuestionPaginator!

Arguments
Name Description
orderBy - [QueryQuestionsOrderByOrderByClause!]
type - String Search by question type.
first - Int! Limits number of fetched items. Default = 10
page - Int The offset from which items are returned.

Example

Query
query Questions(
  $orderBy: [QueryQuestionsOrderByOrderByClause!],
  $type: String,
  $first: Int!,
  $page: Int
) {
  questions(
    orderBy: $orderBy,
    type: $type,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      text
      type
      created_at
      updated_at
    }
  }
}
Variables
{
  "orderBy": [QueryQuestionsOrderByOrderByClause],
  "type": "abc123",
  "first": 10,
  "page": 987
}
Response
{
  "data": {
    "questions": {
      "paginatorInfo": PaginatorInfo,
      "data": [Question]
    }
  }
}
Queries

user

Description

Find a single user by an identifying attribute.

Response

Returns a User

Arguments
Name Description
id - ID Search by primary key.
email - String Search by email address.

Example

Query
query User(
  $id: ID,
  $email: String
) {
  user(
    id: $id,
    email: $email
  ) {
    id
    tenant_id
    name
    email
    email_verified_at
    created_at
    updated_at
  }
}
Variables
{
  "id": "4",
  "email": "abc123"
}
Response
{
  "data": {
    "user": {
      "id": "4",
      "tenant_id": 4,
      "name": "abc123",
      "email": "abc123",
      "email_verified_at": "2018-05-23 13:43:32",
      "created_at": "2018-05-23 13:43:32",
      "updated_at": "2018-05-23 13:43:32"
    }
  }
}
Queries

users

Description

List multiple users.

Response

Returns a UserPaginator!

Arguments
Name Description
orderBy - [QueryUsersOrderByOrderByClause!]
name - String Filters by name. Accepts SQL LIKE wildcards % and _.
first - Int! Limits number of fetched items. Default = 10
page - Int The offset from which items are returned.

Example

Query
query Users(
  $orderBy: [QueryUsersOrderByOrderByClause!],
  $name: String,
  $first: Int!,
  $page: Int
) {
  users(
    orderBy: $orderBy,
    name: $name,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      count
      currentPage
      firstItem
      hasMorePages
      lastItem
      lastPage
      perPage
      total
    }
    data {
      id
      tenant_id
      name
      email
      email_verified_at
      created_at
      updated_at
    }
  }
}
Variables
{
  "orderBy": [QueryUsersOrderByOrderByClause],
  "name": "abc123",
  "first": 10,
  "page": 123
}
Response
{
  "data": {
    "users": {
      "paginatorInfo": PaginatorInfo,
      "data": [User]
    }
  }
}

Types

Answer

Description

A answer object.

Fields
Field Name Description
id - ID! Unique primary key.
question_id - ID! Question primary key.
questionnaire_answer_id - ID! Questionnaire unique primary key.
questionnaire_item_id - ID!
product_id - ID
product_category_id - ID
type - String!
subtype - String
answered_at - DateTimeTz
question - Question!
product - Product
content - [AnswerContent!]!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "question_id": 4,
  "questionnaire_answer_id": "4",
  "questionnaire_item_id": "4",
  "product_id": 4,
  "product_category_id": "4",
  "type": "xyz789",
  "subtype": "abc123",
  "answered_at": "2020-04-20T13:53:12+02:00",
  "question": Question,
  "product": Product,
  "content": [AnswerBoolean],
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

AnswerBoolean

Fields
Field Name Description
id - ID! Unique primary key.
boolean - Boolean User answer.
additional_type - String User additional answer type.
additional_answer - String User additional answer text.
created_at - DateTime! Creation date time.
Example
{
  "id": 4,
  "boolean": true,
  "additional_type": "xyz789",
  "additional_answer": "xyz789",
  "created_at": "2018-05-23 13:43:32"
}
Types

AnswerChoice

Fields
Field Name Description
id - ID! Unique primary key.
choice - Int User answer choice.
label - String User answer label.
additional_type - String User additional answer type.
additional_answer - String User additional answer text.
created_at - DateTime! Creation date time.
Example
{
  "id": "4",
  "choice": 987,
  "label": "abc123",
  "additional_type": "abc123",
  "additional_answer": "abc123",
  "created_at": "2018-05-23 13:43:32"
}
Types

AnswerContent

Types
Union Types

AnswerBoolean

AnswerChoice

AnswerDate

AnswerFile

AnswerNumeric

AnswerText
Example
AnswerBoolean
Types

AnswerDate

Fields
Field Name Description
id - ID! Unique primary key.
date - Date User answer date.
created_at - DateTime! Creation date time.
Example
{
  "id": "4",
  "date": "2011-05-23",
  "created_at": "2018-05-23 13:43:32"
}
Types

AnswerFile

Fields
Field Name Description
id - ID! Unique primary key.
hash - String User answer file hash.
file_name - String User answer file name.
file_mime - String User answer file mimetype.
file_size - String User answer file size.
file_url - String User answer file url.
created_at - DateTime! Creation date time.
Example
{
  "id": 4,
  "hash": "xyz789",
  "file_name": "xyz789",
  "file_mime": "xyz789",
  "file_size": "xyz789",
  "file_url": "abc123",
  "created_at": "2018-05-23 13:43:32"
}
Types

AnswerNumeric

Fields
Field Name Description
id - ID! Unique primary key.
number - Float User answer number.
created_at - DateTime! Creation date time.
Example
{
  "id": 4,
  "number": 987.65,
  "created_at": "2018-05-23 13:43:32"
}
Types

AnswerPaginator

Description

A paginated list of Answer items.

Fields
Field Name Description
paginatorInfo - PaginatorInfo! Pagination information about the list of items.
data - [Answer!]! A list of Answer items.
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [Answer]
}
Types

AnswerText

Fields
Field Name Description
id - ID! Unique primary key.
text - String User answer text
created_at - DateTime! Creation date time.
Example
{
  "id": 4,
  "text": "abc123",
  "created_at": "2018-05-23 13:43:32"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

BusinessUnit

Description

Uma business unit (cliente)

Fields
Field Name Description
id - ID! Chave primária única
name - String! Nome da business unit
contract_value - Float Valor do contrato
contract_time - Int Tempo do contrato
cost_serving_rule_in_min - Int Regra de custo em minutos
cost_serving_rule_alert_min - Int Alerta de regra de custo em minutos
cost_serving_rule_out_min - Int Regra de custo fora em minutos
chain_billing_apportionment_type - String Tipo de rateio de faturamento da cadeia
pointOfSales - [PointOfSale!]! Pontos de venda relacionados
businessUnitChecks - [BusinessUnitCheck!]! Checks de business unit relacionados
created_at - DateTime Data de criação
updated_at - DateTime Data de atualização
Example
{
  "id": "4",
  "name": "abc123",
  "contract_value": 123.45,
  "contract_time": 987,
  "cost_serving_rule_in_min": 123,
  "cost_serving_rule_alert_min": 123,
  "cost_serving_rule_out_min": 123,
  "chain_billing_apportionment_type": "xyz789",
  "pointOfSales": [PointOfSale],
  "businessUnitChecks": [BusinessUnitCheck],
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

BusinessUnitCheck

Description

Check de Business Unit

Fields
Field Name Description
id - ID! Chave primária única
work_schedule_id - ID! ID do work schedule
datetime_in - DateTime! Data e hora de check-in
datetime_out - DateTime Data e hora de check-out
timezone_in - String Fuso horário no check-in
timezone_out - String Fuso horário no check-out
battery_in - Int Nível de bateria no check-in
battery_out - Int Nível de bateria no check-out
hash - String Hash único do check-in
hash_out - String Hash único do check-out
hash_pos_check - String Hash do point of sale check relacionado
business_unit - BusinessUnit! Business unit relacionada
user - User! Usuário que fez o check
point_of_sale_check - PointOfSaleCheck! Point of sale check relacionado
work_schedule - WorkSchedule Work schedule relacionado
point_of_sale - PointOfSale Ponto de venda relacionado (via point of sale check)
created_at - DateTime Data de criação
updated_at - DateTime Data de atualização
Example
{
  "id": "4",
  "work_schedule_id": 4,
  "datetime_in": "2018-05-23 13:43:32",
  "datetime_out": "2018-05-23 13:43:32",
  "timezone_in": "xyz789",
  "timezone_out": "xyz789",
  "battery_in": 123,
  "battery_out": 987,
  "hash": "xyz789",
  "hash_out": "abc123",
  "hash_pos_check": "xyz789",
  "business_unit": BusinessUnit,
  "user": User,
  "point_of_sale_check": PointOfSaleCheck,
  "work_schedule": WorkSchedule,
  "point_of_sale": PointOfSale,
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

BusinessUnitCheckPaginator

Description

A paginated list of BusinessUnitCheck items.

Fields
Field Name Description
paginatorInfo - PaginatorInfo! Pagination information about the list of items.
data - [BusinessUnitCheck!]! A list of BusinessUnitCheck items.
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [BusinessUnitCheck]
}
Types

Chain

Description

A chain object.

Fields
Field Name Description
id - ID! Unique primary key.
name - String!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "name": "abc123",
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

Channel

Description

A channel object.

Fields
Field Name Description
id - ID! Unique primary key.
name - String!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "name": "xyz789",
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

City

Description

A city object.

Fields
Field Name Description
id - ID! Unique primary key.
title - String!
iso - Int!
slug - String!
state - State!
Example
{
  "id": "4",
  "title": "xyz789",
  "iso": 123,
  "slug": "abc123",
  "state": State
}
Types

Cnpj

Description

A CNPJ (Cadastro Nacional da Pessoa Jurídica) is a unique identification number assigned to Brazilian companies. It is a 14-digit number that is divided into three parts: the first eight digits represent the company, the next four digits represent the branch or subsidiary, and the last two digits represent the check digits, e.g. 07.438.695/0001-46.

Example
"07.438.695/0001-46"
Types

Date

Description

A date string with format Y-m-d, e.g. 2011-05-23.

Example
"2011-05-23"
Types

DateTime

Description

A datetime string with format Y-m-d H:i:s, e.g. 2018-05-23 13:43:32.

Example
"2018-05-23 13:43:32"
Types

DateTimeRange

Description

A range between two dates.

Fields
Input Field Description
from - DateTime!
to - DateTime!
Example
{
  "from": "2018-05-23 13:43:32",
  "to": "2018-05-23 13:43:32"
}
Types

DateTimeTz

Description

A datetime and timezone string in ISO 8601 format Y-m-dTH:i:sP, e.g. 2020-04-20T13:53:12+02:00.

Example
"2020-04-20T13:53:12+02:00"
Types

Flag

Description

A flag object.

Fields
Field Name Description
id - ID! Unique primary key.
name - String!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "name": "xyz789",
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
4
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
123
Types

PaginatorInfo

Description

Information about pagination using a fully featured paginator.

Fields
Field Name Description
count - Int! Number of items in the current page.
currentPage - Int! Index of the current page.
firstItem - Int Index of the first item in the current page.
hasMorePages - Boolean! Are there more pages after this one?
lastItem - Int Index of the last item in the current page.
lastPage - Int! Index of the last available page.
perPage - Int! Number of items per page.
total - Int! Number of total available items.
Example
{
  "count": 123,
  "currentPage": 123,
  "firstItem": 987,
  "hasMorePages": true,
  "lastItem": 987,
  "lastPage": 987,
  "perPage": 987,
  "total": 123
}
Types

Point

Description

A geography point

Fields
Field Name Description
latitude - Float!
longitude - Float!
Example
{"latitude": 987.65, "longitude": 987.65}
Types

PointOfSale

Description

A point of sale object.

Fields
Field Name Description
id - ID! Unique primary key.
name - String!
zip_code - ZipCode
address - String
number - String
district - String
complement - String
external_code - String
chain_external_code - String
cnpj - Cnpj
is_active - Boolean!
category - PointOfSaleCategory
chain - Chain
channel - Channel
regional - Regional
flag - Flag
city - City
state - State
location - Point
commercial_responsible - ResponsibleContact
merchandising_responsible - ResponsibleContact
created_at - DateTime
updated_at - DateTime
Example
{
  "id": 4,
  "name": "abc123",
  "zip_code": "01000-000",
  "address": "xyz789",
  "number": "xyz789",
  "district": "abc123",
  "complement": "xyz789",
  "external_code": "abc123",
  "chain_external_code": "xyz789",
  "cnpj": "07.438.695/0001-46",
  "is_active": true,
  "category": PointOfSaleCategory,
  "chain": Chain,
  "channel": Channel,
  "regional": Regional,
  "flag": Flag,
  "city": City,
  "state": State,
  "location": Point,
  "commercial_responsible": ResponsibleContact,
  "merchandising_responsible": ResponsibleContact,
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

PointOfSaleCategory

Description

A point of sale category object.

Fields
Field Name Description
id - ID! Unique primary key.
name - String!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "name": "abc123",
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

PointOfSaleCheck

Description

Check de Ponto de Venda

Fields
Field Name Description
id - ID! Chave primária única
datetime_in - DateTime! Data e hora de check-in
datetime_out - DateTime Data e hora de check-out
timezone_in - String Fuso horário no check-in
timezone_out - String Fuso horário no check-out
battery_in - Int Nível de bateria no check-in
battery_out - Int Nível de bateria no check-out
distance_in - Float Distância no check-in
distance_out - Float Distância no check-out
elapsed_time - Int Tempo decorrido (em segundos)
forced_checkout - Boolean Indica se o checkout foi forçado
location_in - Point Localização no check-in
location_out - Point Localização no check-out
hash - String Hash único do check-in
hash_out - String Hash único do check-out
point_of_sale - PointOfSale! Ponto de venda relacionado
user - User! Usuário que fez o check
business_unit_checks - [BusinessUnitCheck!]! Business unit checks relacionados
file_checkin - String Foto do check-in
file_checkout - String Foto do check-out
created_at - DateTime Data de criação
updated_at - DateTime Data de atualização
Example
{
  "id": 4,
  "datetime_in": "2018-05-23 13:43:32",
  "datetime_out": "2018-05-23 13:43:32",
  "timezone_in": "xyz789",
  "timezone_out": "abc123",
  "battery_in": 987,
  "battery_out": 123,
  "distance_in": 987.65,
  "distance_out": 123.45,
  "elapsed_time": 987,
  "forced_checkout": true,
  "location_in": Point,
  "location_out": Point,
  "hash": "abc123",
  "hash_out": "abc123",
  "point_of_sale": PointOfSale,
  "user": User,
  "business_unit_checks": [BusinessUnitCheck],
  "file_checkin": "abc123",
  "file_checkout": "abc123",
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

PointOfSaleCheckPaginator

Description

A paginated list of PointOfSaleCheck items.

Fields
Field Name Description
paginatorInfo - PaginatorInfo! Pagination information about the list of items.
data - [PointOfSaleCheck!]! A list of PointOfSaleCheck items.
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [PointOfSaleCheck]
}
Types

PointOfSalePaginator

Description

A paginated list of PointOfSale items.

Fields
Field Name Description
paginatorInfo - PaginatorInfo! Pagination information about the list of items.
data - [PointOfSale!]! A list of PointOfSale items.
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [PointOfSale]
}
Types

Product

Description

A product object.

Fields
Field Name Description
id - ID! Unique primary key.
product_category_id - ID!
brand_id - ID
name - String!
active - Boolean!
category - ProductCategory!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "product_category_id": 4,
  "brand_id": 4,
  "name": "xyz789",
  "active": true,
  "category": ProductCategory,
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

ProductCategory

Description

A product category object.

Fields
Field Name Description
id - ID! Unique primary key.
name - String!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": 4,
  "name": "abc123",
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

ProductPaginator

Description

A paginated list of Product items.

Fields
Field Name Description
paginatorInfo - PaginatorInfo! Pagination information about the list of items.
data - [Product!]! A list of Product items.
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [Product]
}
Types

QueryAnswerOrderByColumn

Description

Allowed column names for Query.answers.orderBy

Values
Enum Value Description

ANSWERED_AT

ID
Example
"ANSWERED_AT"
Types

QueryAnswersOrderByOrderByClause

Description

Order by clause for Query.answers.orderBy.

Fields
Input Field Description
column - QueryAnswerOrderByColumn! The column that is used for ordering.
order - SortOrder! The direction that is used for ordering.
Example
{"column": "ANSWERED_AT", "order": "ASC"}
Types

QueryBusinessUnitCheckOrderByColumn

Description

Colunas permitidas para ordenar Query.businessUnitChecks

Values
Enum Value Description

DATETIME_IN

DATETIME_OUT

ID
Example
"DATETIME_IN"
Types

QueryBusinessUnitChecksOrderByOrderByClause

Description

Order by clause for Query.businessUnitChecks.orderBy.

Fields
Input Field Description
column - QueryBusinessUnitCheckOrderByColumn! The column that is used for ordering.
order - SortOrder! The direction that is used for ordering.
Example
{"column": "DATETIME_IN", "order": "ASC"}
Types

QueryPointOfSaleCheckOrderByColumn

Description

Colunas permitidas para ordenar Query.pointOfSaleChecks

Values
Enum Value Description

DATETIME_IN

DATETIME_OUT

ID
Example
"DATETIME_IN"
Types

QueryPointOfSaleChecksOrderByOrderByClause

Description

Order by clause for Query.pointOfSaleChecks.orderBy.

Fields
Input Field Description
column - QueryPointOfSaleCheckOrderByColumn! The column that is used for ordering.
order - SortOrder! The direction that is used for ordering.
Example
{"column": "DATETIME_IN", "order": "ASC"}
Types

QueryPointOfSaleOrderByColumn

Description

Allowed column names for Query.pointOfSales.orderBy

Values
Enum Value Description

UPDATED_AT

ID
Example
"UPDATED_AT"
Types

QueryPointOfSalesOrderByOrderByClause

Description

Order by clause for Query.pointOfSales.orderBy.

Fields
Input Field Description
column - QueryPointOfSaleOrderByColumn! The column that is used for ordering.
order - SortOrder! The direction that is used for ordering.
Example
{"column": "UPDATED_AT", "order": "ASC"}
Types

QueryProductOrderByColumn

Description

Allowed column names for Query.products.orderBy

Values
Enum Value Description

UPDATED_AT

ID
Example
"UPDATED_AT"
Types

QueryProductsOrderByOrderByClause

Description

Order by clause for Query.products.orderBy.

Fields
Input Field Description
column - QueryProductOrderByColumn! The column that is used for ordering.
order - SortOrder! The direction that is used for ordering.
Example
{"column": "UPDATED_AT", "order": "ASC"}
Types

QueryQuestionOrderByColumn

Description

Allowed column names for Query.questions.orderBy

Values
Enum Value Description

UPDATED_AT

ID
Example
"UPDATED_AT"
Types

QueryQuestionnaireAnswerOrderByColumn

Description

Allowed column names for Query.questionnaireAnswers.orderBy

Values
Enum Value Description

ANSWERED_AT

ID
Example
"ANSWERED_AT"
Types

QueryQuestionnaireAnswersOrderByOrderByClause

Description

Order by clause for Query.questionnaireAnswers.orderBy.

Fields
Input Field Description
column - QueryQuestionnaireAnswerOrderByColumn! The column that is used for ordering.
order - SortOrder! The direction that is used for ordering.
Example
{"column": "ANSWERED_AT", "order": "ASC"}
Types

QueryQuestionnaireOrderByColumn

Description

Allowed column names for Query.questionnaires.orderBy

Values
Enum Value Description

UPDATED_AT

ID
Example
"UPDATED_AT"
Types

QueryQuestionnairesOrderByOrderByClause

Description

Order by clause for Query.questionnaires.orderBy.

Fields
Input Field Description
column - QueryQuestionnaireOrderByColumn! The column that is used for ordering.
order - SortOrder! The direction that is used for ordering.
Example
{"column": "UPDATED_AT", "order": "ASC"}
Types

QueryQuestionsOrderByOrderByClause

Description

Order by clause for Query.questions.orderBy.

Fields
Input Field Description
column - QueryQuestionOrderByColumn! The column that is used for ordering.
order - SortOrder! The direction that is used for ordering.
Example
{"column": "UPDATED_AT", "order": "ASC"}
Types

QueryUserOrderByColumn

Description

Allowed column names for Query.users.orderBy

Values
Enum Value Description

UPDATED_AT

ID
Example
"UPDATED_AT"
Types

QueryUsersOrderByOrderByClause

Description

Order by clause for Query.users.orderBy.

Fields
Input Field Description
column - QueryUserOrderByColumn! The column that is used for ordering.
order - SortOrder! The direction that is used for ordering.
Example
{"column": "UPDATED_AT", "order": "ASC"}
Types

Question

Description

A question object.

Fields
Field Name Description
id - ID! Unique primary key.
text - String!
type - String!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": 4,
  "text": "xyz789",
  "type": "xyz789",
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

QuestionPaginator

Description

A paginated list of Question items.

Fields
Field Name Description
paginatorInfo - PaginatorInfo! Pagination information about the list of items.
data - [Question!]! A list of Question items.
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [Question]
}
Types

Questionnaire

Description

A questionnaire object.

Fields
Field Name Description
id - ID! Unique primary key.
name - String!
type - String!
is_justifiable - Boolean!
created_at - DateTime
updated_at - DateTime
items - [QuestionnaireItem]
Example
{
  "id": "4",
  "name": "xyz789",
  "type": "abc123",
  "is_justifiable": true,
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32",
  "items": [QuestionnaireItem]
}
Types

QuestionnaireAnswer

Description

A questionnaire answer object.

Fields
Field Name Description
id - ID! Unique primary key.
user_id - ID! User primary key.
tenant_id - ID!
questionnaire_id - ID! Questionnaire primary key.
point_of_sale_id - ID
business_unit_id - ID
product_id - ID
product_category_id - ID
user - User!
questionnaire - Questionnaire!
answers - [Answer]
product - Product
category - ProductCategory
answered_at - DateTimeTz
Example
{
  "id": 4,
  "user_id": 4,
  "tenant_id": 4,
  "questionnaire_id": 4,
  "point_of_sale_id": 4,
  "business_unit_id": 4,
  "product_id": 4,
  "product_category_id": "4",
  "user": User,
  "questionnaire": Questionnaire,
  "answers": [Answer],
  "product": Product,
  "category": ProductCategory,
  "answered_at": "2020-04-20T13:53:12+02:00"
}
Types

QuestionnaireAnswerPaginator

Description

A paginated list of QuestionnaireAnswer items.

Fields
Field Name Description
paginatorInfo - PaginatorInfo! Pagination information about the list of items.
data - [QuestionnaireAnswer!]! A list of QuestionnaireAnswer items.
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [QuestionnaireAnswer]
}
Types

QuestionnaireItem

Description

A questionnaire item object.

Fields
Field Name Description
id - ID! Unique primary key.
next_id - ID Next questionnaire item.
is_required - Boolean It is a mandatory item to answer in the questionnaire.
is_end - Boolean This item ends the questionnaire.
question - Question! Questions displayed in the questionnaire item.
Example
{
  "id": 4,
  "next_id": "4",
  "is_required": true,
  "is_end": false,
  "question": Question
}
Types

QuestionnairePaginator

Description

A paginated list of Questionnaire items.

Fields
Field Name Description
paginatorInfo - PaginatorInfo! Pagination information about the list of items.
data - [Questionnaire!]! A list of Questionnaire items.
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [Questionnaire]
}
Types

Regional

Description

A regional object.

Fields
Field Name Description
id - ID! Unique primary key.
name - String!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "4",
  "name": "xyz789",
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

ResponsibleContact

Fields
Field Name Description
name - String
email - String
Example
{
  "name": "xyz789",
  "email": "abc123"
}
Types

SortOrder

Description

Directions for ordering a list of records.

Values
Enum Value Description

ASC

 Sort records in ascending order.

DESC

 Sort records in descending order.
Example
"ASC"
Types

State

Description

A state object.

Fields
Field Name Description
id - ID! Unique primary key.
title - String!
letter - String!
iso - Int!
slug - String!
Example
{
  "id": 4,
  "title": "xyz789",
  "letter": "xyz789",
  "iso": 987,
  "slug": "xyz789"
}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

User

Description

A user object.

Fields
Field Name Description
id - ID! Unique primary key.
tenant_id - ID!
name - String! Non-unique name.
email - String! Unique email address.
email_verified_at - DateTime When the email was verified.
created_at - DateTime! When the account was created.
updated_at - DateTime! When the account was last updated.
Example
{
  "id": 4,
  "tenant_id": "4",
  "name": "abc123",
  "email": "abc123",
  "email_verified_at": "2018-05-23 13:43:32",
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

UserPaginator

Description

A paginated list of User items.

Fields
Field Name Description
paginatorInfo - PaginatorInfo! Pagination information about the list of items.
data - [User!]! A list of User items.
Example
{
  "paginatorInfo": PaginatorInfo,
  "data": [User]
}
Types

WorkSchedule

Description

Uma programação de trabalho

Fields
Field Name Description
id - ID! Chave primária única
schedule_date - Date Data da programação
status - String Status da programação
created_at - DateTime Data de criação
updated_at - DateTime Data de atualização
Example
{
  "id": "4",
  "schedule_date": "2011-05-23",
  "status": "abc123",
  "created_at": "2018-05-23 13:43:32",
  "updated_at": "2018-05-23 13:43:32"
}
Types

ZipCode

Description

A CEP (Código de Endereçamento Postal) is a postal code used in Brazil to identify a specific location. It is composed of eight digits, separated by a hyphen, with the first five digits representing the city, district, or sub-district, and the last three digits representing the block or building, e.g. 01000-000.

Example
"01000-000"
Documentation by Anvil SpectaQL