user

Fetch user records matching the supplied arguments.

Arguments

Argument	Type	Required	Description
`id`	`String`	No	Filter by ID; pass the public API ID unless the field name says legacy ID.
`customer_account_id`	`String`	No	Use this when you are a 3PL acting on behalf of one of your customers.
`email`	`String`	No	Lookup by email within the selected account context.
`account_pin`	`String`	No	Lookup by account pin within the selected account context.
`analyze`	`Boolean`	No	If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

UserQueryResult

Query

query user(
  $id: String,
  $customer_account_id: String,
  $email: String,
  $account_pin: String,
  $analyze: Boolean
) {
  user(
    id: $id,
    customer_account_id: $customer_account_id,
    email: $email,
    account_pin: $account_pin,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...UserFragment
    
      id
      legacy_id
      email
      first_name
      last_name
      created_at
      updated_at
      is_admin
      profile_image
      default_picking_option
      position
      hourly_rate
      payroll_id
      default_order_status
      default_warehouse_id
      is_active
      is_developer
      default_pick_order_tag
      account {
        ...AccountFragment
      
        id
        legacy_id
        email
        username
        status
        dynamic_slotting
        is_multi_warehouse
        is_3pl
        cycle_count_enabled
        ship_backorders
        warehouse_relationship {
          ...WarehouseRelationshipFragment
        
          from_name
          pause_shipping
        }
        lot_tracking_settings {
          ...AccountLotTrackingSettingsFragment
        
          is_active
          priority
          picking_disabled_period_in_days
          verify_lot_when_packing
          exclude_expired_quantity_from_available
          lots_about_to_expire_email
        }
        customers {
          ...AccountConnectionFragment
        
          pageInfo {
            ...PageInfoFragment
          
            hasNextPage
            hasPreviousPage
            startCursor
            endCursor
          }
          edges {
            ...AccountEdgeFragment
          
            node {
              ...AccountFragment
            }
            cursor
          }
        }
        warehouses {
          ...WarehouseFragment
        
          id
          legacy_id
          account_id
          identifier
          dynamic_slotting
          invoice_email
          phone_number
          profile
          address {
            ...AddressFragment
          
            name
            address1
            address2
            city
            state
            country
            zip
            phone
          }
          return_address {
            ...AddressFragment
          
            name
            address1
            address2
            city
            state
            country
            zip
            phone
          }
          company_name
          company_alias
          active
          products {
            ...ProductConnectionFragment
          
            pageInfo {
              ...PageInfoFragment
            
              hasNextPage
              hasPreviousPage
              startCursor
              endCursor
            }
            edges {
              ...ProductEdgeFragment
            
              node {
                ...ProductFragment
              
                id
                legacy_id
                account_id
                name
                sku
                price
                value
                value_currency
                barcode
                country_of_manufacture
                dimensions {
                  ...DimensionsFragment
                
                  weight
                  height
                  width
                  length
                }
                tariff_code
                kit
                kit_build
                no_air
                final_sale
                customs_value
                customs_description
                not_owned
                dropship
                needs_serial_number
                thumbnail
                large_thumbnail
                created_at
                updated_at
                product_note
                virtual
                ignore_on_invoice
                ignore_on_customs
                active
                needs_lot_tracking
                is_assembly
                packer_note
                size
                style
                vendor_part_number
                consumer_package_code
                buyer_part_number
                buyer_style_number
                auto_pack
                warehouse_products {
                  ...WarehouseProductFragment
                
                  id
                  legacy_id
                  account_id
                  sku
                  warehouse_id
                  warehouse_identifier
                  price
                  value
                  value_currency
                  on_hand
                  inventory_bin
                  inventory_overstock_bin
                  reserve_inventory
                  replenishment_level
                  replenishment_max_level
                  replenishment_increment
                  reorder_amount
                  reorder_level
                  backorder
                  allocated
                  available
                  non_sellable_quantity
                  in_tote
                  custom
                  customs_value
                  created_at
                  updated_at
                  sell_ahead
                  active
                  warehouse {
                    ...WarehouseFragment
                  }
                  product {
                    ...ProductFragment
                  }
                  inbounds {
                    ...WarehouseProductInboundConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...WarehouseProductInboundEdgeFragment
                    }
                  }
                  locations {
                    ...ItemLocationConnectionFragment
                  
                    pageInfo {
                      ...PageInfoFragment
                    }
                    edges {
                      ...ItemLocationEdgeFragment
                    }
                  }
                }
                fba_inventory {
                  ...FbaInventoryFragment
                
                  id
                  legacy_id
                  quantity
                  marketplace_id
                  merchant_id
                }
                images {
                  ...ProductImageFragment
                
                  src
                  position
                }
                tags
                vendors {
                  ...ProductVendorFragment
                
                  vendor_id
                  vendor_sku
                  price
                }
                components {
                  ...ProductFragment
                }
                kit_components {
                  ...KitComponentFragment
                
                  id
                  legacy_id
                  account_id
                  sku
                  quantity
                }
                assembly_components {
                  ...AssemblyComponentFragment
                
                  id
                  legacy_id
                  account_id
                  sku
                  quantity
                }
                cases {
                  ...CaseFragment
                
                  id
                  legacy_id
                  case_barcode
                  case_quantity
                }
              }
              cursor
            }
          }
        }
      }
      allowed_warehouses {
        ...WarehouseFragment
      
        id
        legacy_id
        account_id
        identifier
        dynamic_slotting
        invoice_email
        phone_number
        profile
        address {
          ...AddressFragment
        
          name
          address1
          address2
          city
          state
          country
          zip
          phone
        }
        return_address {
          ...AddressFragment
        
          name
          address1
          address2
          city
          state
          country
          zip
          phone
        }
        company_name
        company_alias
        active
        products {
          ...ProductConnectionFragment
        
          pageInfo {
            ...PageInfoFragment
          
            hasNextPage
            hasPreviousPage
            startCursor
            endCursor
          }
          edges {
            ...ProductEdgeFragment
          
            node {
              ...ProductFragment
            
              id
              legacy_id
              account_id
              name
              sku
              price
              value
              value_currency
              barcode
              country_of_manufacture
              dimensions {
                ...DimensionsFragment
              
                weight
                height
                width
                length
              }
              tariff_code
              kit
              kit_build
              no_air
              final_sale
              customs_value
              customs_description
              not_owned
              dropship
              needs_serial_number
              thumbnail
              large_thumbnail
              created_at
              updated_at
              product_note
              virtual
              ignore_on_invoice
              ignore_on_customs
              active
              needs_lot_tracking
              is_assembly
              packer_note
              size
              style
              vendor_part_number
              consumer_package_code
              buyer_part_number
              buyer_style_number
              auto_pack
              warehouse_products {
                ...WarehouseProductFragment
              
                id
                legacy_id
                account_id
                sku
                warehouse_id
                warehouse_identifier
                price
                value
                value_currency
                on_hand
                inventory_bin
                inventory_overstock_bin
                reserve_inventory
                replenishment_level
                replenishment_max_level
                replenishment_increment
                reorder_amount
                reorder_level
                backorder
                allocated
                available
                non_sellable_quantity
                in_tote
                custom
                customs_value
                created_at
                updated_at
                sell_ahead
                active
                warehouse {
                  ...WarehouseFragment
                }
                product {
                  ...ProductFragment
                }
                inbounds {
                  ...WarehouseProductInboundConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...WarehouseProductInboundEdgeFragment
                  
                    node {
                      ...WarehouseProductInboundFragment
                    }
                    cursor
                  }
                }
                locations {
                  ...ItemLocationConnectionFragment
                
                  pageInfo {
                    ...PageInfoFragment
                  
                    hasNextPage
                    hasPreviousPage
                    startCursor
                    endCursor
                  }
                  edges {
                    ...ItemLocationEdgeFragment
                  
                    node {
                      ...ItemLocationFragment
                    }
                    cursor
                  }
                }
              }
              fba_inventory {
                ...FbaInventoryFragment
              
                id
                legacy_id
                quantity
                marketplace_id
                merchant_id
              }
              images {
                ...ProductImageFragment
              
                src
                position
              }
              tags
              vendors {
                ...ProductVendorFragment
              
                vendor_id
                vendor_sku
                price
              }
              components {
                ...ProductFragment
              }
              kit_components {
                ...KitComponentFragment
              
                id
                legacy_id
                account_id
                sku
                quantity
              }
              assembly_components {
                ...AssemblyComponentFragment
              
                id
                legacy_id
                account_id
                sku
                quantity
              }
              cases {
                ...CaseFragment
              
                id
                legacy_id
                case_barcode
                case_quantity
              }
            }
            cursor
          }
        }
      }
      stores {
        ...StoreFragment
      
        id
        legacy_id
        shop_name
      }
    }
  }
}

Variables

{
  "id": "UmVjb3JkOjEyMzQ=",
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "email": "customer@example.com",
  "account_pin": "2",
  "analyze": true
}

Response

{
  "data": {
    "user": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "VXNlcjoxMjM0"}
    }
  }
}